Improve command regexps

[app-statsbot.git] / statsbot

diff --git a/statsbot b/statsbot
index 2545fc507e75ff6d18d755a6bbb173e5c277d53d..de88ae232a4a93c6ad8a027a787c9d8249edcf3d 100755 (executable)
--- a/statsbot
+++ b/statsbot
@@ -33,7 +33,10 @@ statsbot - simple IRC bot that tracks time spent in a channel
   # < mgv> !presence mgv
   # < mgv>   presence mgv '1 day'
   # < mgv> BOTNICK: !presence mgv '1 year' 2
-  # < mgv> BOTNICK:    presence   mgv
+  # < mgv> BOTNICK,    presence   mgv
+  # < mgv>   !help
+  # < mgv> BOTNICK:    help
+  # < mgv> BOTNICK,  help
 
 =head1 DESCRIPTION
 
@@ -96,6 +99,46 @@ not exist. Defaults to C</var/lib/statsbot/db>.
 
 =back
 
+=head1 ENVIRONMENT
+
+All options can be passed via the environment. If an option is passed both as an environment variable and as an argument, the argument takes priority.
+
+=over
+
+=item B<STATSBOT_DEBUG>=I<1>
+
+Equivalent to B<--debug>.
+
+=item B<STATSBOT_TICK>=I<60>
+
+Equivalent to B<--tick>=I<60>.
+
+=item B<STATSBOT_NICKNAME>=I<"timebot">
+
+Equivalent to B<--nickname>=I<"timebot">.
+
+=item B<STATSBOT_SERVER>=I<"irc.oftc.net">
+
+Equivalent to B<--server>=I<"irc.oftc.net">.
+
+=item B<STATSBOT_PORT>=I<6697>
+
+Equivalent to B<--port>=I<6697>.
+
+=item B<STATSBOT_SSL>=I<1>
+
+Equivalent to B<--ssl>.
+
+=item B<STATSBOT_CHANNELS>=I<"#mychan #otherchan">
+
+Equivalent to B<--channel>=I<#mychan> B<--channel>=I<#otherchan>.
+
+=item B<STATSBOT_DB>=I<"/path/to/some/file.sqlite">
+
+Equivalent to B<--db>=I<"/path/to/some/file.sqlite">.
+
+=back
+
 =head1 SEE ALSO
 
 L<App::Statsbot>