diff --git a/docs/man/supybot-botchk.1 b/docs/man/supybot-botchk.1 new file mode 100644 index 000000000..e75eb2e18 --- /dev/null +++ b/docs/man/supybot-botchk.1 @@ -0,0 +1,55 @@ +.\" Process this file with +.\" groff -man -Tascii supybot-botchk.1 +.\" +.TH SUPYBOT\-BOTCHK 1 "APRIL 2005" +.SH NAME +supybot\-botchk \- A script to start Supybot if it's not already running. +.SH SYNOPSIS +.B supybot\-botchk +.RI [ options ] +.SH DESCRIPTION +.B +supybot\-botchk +is a script that will start Supybot if it detects that one is not currently +running. This can be useful for scheduling +.IR supybot +to run via +.IR cron (8). +.SH OPTIONS +.TP +.BR \-h ", " \-\^\-help +Show summary of options. +.TP +.BR \-v ", " \-\^\-verbose +Use verbose output when running the script. +.TP +.BI \-\^\-botdir=" BOTDIR +Determines which directory the bot be started in. +.TP +.BI \-\^\-pidfile=" PIDFILE +Specifies the name of the pidfile to look for. This should be relative +to the given botdir. +.TP +.BI \-\^\-supybot=" SUPYBOT +Specifies the location of +.IR supybot (1). +If this is not given, it is assumed that +.IR supybot (1) +is in the user's $PATH. +.TP +.BI \-\^\-conffile=" CONFFILE +Specifies the path to the bot's configuration file. This will be used +when (re)starting the bot. +.SH "SEE ALSO" +.IR python (1), +.IR supybot (1), +.IR supybot\-test (1), +.IR supybot\-wizard (1), +.IR supybot\-adduser (1), +.IR supybot\-plugin\-doc (1), +.IR supybot\-plugin\-create (1) +.SH AUTHOR +This manual page was originally written by James Vega +. Permission is granted to copy, +distribute and/or modify this document under the terms of the Supybot +license, a BSD\-style license.