From c602a6081007ae1e49a912c13fec0685bb9f9263 Mon Sep 17 00:00:00 2001 From: Giuseppe Bilotta Date: Tue, 11 Mar 2008 01:20:42 +0100 Subject: Documentation cleanups Fix typos, be more rdocish, and use the README as the main file --- bin/rbot | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) (limited to 'bin') diff --git a/bin/rbot b/bin/rbot index 382725c2..8e762569 100755 --- a/bin/rbot +++ b/bin/rbot @@ -1,5 +1,41 @@ #!/usr/bin/env ruby +=begin rdoc + += rbot main executable + +Usage: + + % rbot [options] [config directory] + +== Options + +[-h, --help] + display a help message and exit +[-v, --version] + display version information and exit +[-d, --debug] + enable debug messages +[-l, --loglevel _level_] + sets the minimum log level verbosity +[-b, --background] + background (daemonize) the bot +[-p, --pidfile _filename_] + write the bot pid to _filename_ + +The default config directory is ~/.rbot. + +The default pidfile is botdir/rbot.pid. + +The logfile is located at botdir/botname.log, and +the default loglevel is 1 (INFO messages). Possible values for the loglevel +are 0 (DEBUG), 1 (INFO), 2 (WARN), 3 (ERROR), 4 (FATAL). + +Please note that the logfile doesn't contain IRC logs (which are located at +botdir/logs/*, but only rbot diagnostic messages. + +=end + # Copyright (C) 2002 Tom Gilbert. # # Permission is hereby granted, free of charge, to any person obtaining a copy @@ -143,8 +179,9 @@ if ($opts["help"]) puts " -h, --help this message" puts " -v, --version version information" puts " -d, --debug enable debug messages" + puts " -l, --loglevel sets the log level verbosity" puts " -b, --background background (daemonize) the bot" - puts " -p, --pidfile write the bot pid to this file" + puts " -p, --pidfile write the bot pid to file" puts "config directory defaults to ~/.rbot" exit 0 end -- cgit v1.2.3