chiark / gitweb /
Add a disorder-choose man page
authorRichard Kettlewell <rjk@greenend.org.uk>
Sat, 17 Jan 2009 13:31:22 +0000 (13:31 +0000)
committerRichard Kettlewell <rjk@greenend.org.uk>
Sat, 17 Jan 2009 13:31:22 +0000 (13:31 +0000)
.bzrignore
doc/Makefile.am
doc/disorder-choose.8.in [new file with mode: 0644]
examples/disorder.init.in

index 1bea24f..022ddca 100644 (file)
@@ -198,3 +198,5 @@ libtests/t-eventdist
 doc/disorder_preferences.5
 doc/disorder_preferences.5.html
 plugins/index.html
+doc/disorder-choose.8
+doc/disorder-choose.8.html
index 4989437..417d703 100644 (file)
@@ -1,6 +1,6 @@
 #
 # This file is part of DisOrder.
-# Copyright (C) 2004-2008 Richard Kettlewell
+# Copyright (C) 2004-2009 Richard Kettlewell
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -24,14 +24,14 @@ man_MANS=disorderd.8 disorder.1 disorder.3 disorder_config.5 disorder-dump.8 \
        disorder-playrtp.1 disorder-normalize.8 disorder-decode.8 \
        disorder-stats.8 disorder-dbupgrade.8 disorder_templates.5 \
        disorder_actions.5 disorder_options.5 disorder.cgi.8 \
-       disorder_preferences.5
+       disorder_preferences.5 disorder-choose.8
 
 SEDFILES=disorder.1 disorderd.8 disorder_config.5 \
        disorder-dump.8 disorder_protocol.5 disorder-deadlock.8 \
        disorder-rescan.8 disobedience.1 disorderfm.1 disorder-playrtp.1 \
        disorder-decode.8 disorder-stats.8 disorder-dbupgrade.8 \
        disorder_options.5 disorder.cgi.8 disorder_templates.5 \
-       disorder_actions.5 disorder_preferences.5
+       disorder_actions.5 disorder_preferences.5 disorder-choose.8
 
 include ${top_srcdir}/scripts/sedfiles.make
 
diff --git a/doc/disorder-choose.8.in b/doc/disorder-choose.8.in
new file mode 100644 (file)
index 0000000..709e1ec
--- /dev/null
@@ -0,0 +1,52 @@
+.\"
+.\" Copyright (C) 2009 Richard Kettlewell
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\" 
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\" 
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
+.\"
+.TH disorder-choose 8
+.SH NAME
+disorder-choose \- DisOrder track chooser
+.SH SYNOPSIS
+.B disorder\-choose
+.RI [ OPTIONS ]
+.SH DESCRIPTION
+.B disorder\-choose
+chooses a track to play at random and writes it to standard output.
+It is used by the server and would not normally be invoked manually.
+.SH OPTIONS
+.TP
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
+Set the configuration file.
+.TP
+.B \-\-debug\fR, \fB\-d
+Enable debugging.
+.TP
+.B \-\-syslog
+Log to syslog.
+This is the default if stderr is not a terminal.
+.TP
+.B \-\-no\-syslog
+Do not log to syslog.
+This is the default if stderr is a terminal.
+.TP
+.B \-\-help\fR, \fB\-h
+Display a usage message.
+.TP
+.B \-\-version\fR, \fB\-V
+Display version number.
+.SH "SEE ALSO"
+\fBdisorderd\fR(8), \fBdisorder_config\fR(5)
+.\" Local Variables:
+.\" mode:nroff
+.\" End:
index 602effc..b752adc 100644 (file)
@@ -1,7 +1,7 @@
 #! /bin/sh
 #
 # This file is part of DisOrder.
-# Copyright (C) 2004, 2005, 2007 Richard Kettlewell
+# Copyright (C) 2004, 2005, 2007, 2009 Richard Kettlewell
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by