From 0d350ff0f9e835fe30e599d437374fecf5e3bd44 Mon Sep 17 00:00:00 2001 Message-Id: <0d350ff0f9e835fe30e599d437374fecf5e3bd44.1715397484.git.mdw@distorted.org.uk> From: Mark Wooding Date: Sun, 24 Feb 2008 19:20:08 +0000 Subject: [PATCH] Escape dashes that really do need to be minus signs. As previously this follows advice from Colin. Organization: Straylight/Edgeware From: Richard Kettlewell --- doc/disobedience.1.in | 30 ++++++++++++++-------------- doc/disorder-dbupgrade.8.in | 24 +++++++++++----------- doc/disorder-deadlock.8.in | 18 ++++++++--------- doc/disorder-decode.8.in | 8 ++++---- doc/disorder-dump.8.in | 34 +++++++++++++++---------------- doc/disorder-normalize.8 | 16 +++++++-------- doc/disorder-playrtp.1.in | 38 +++++++++++++++++------------------ doc/disorder-rescan.8.in | 16 +++++++-------- doc/disorder-speaker.8 | 12 +++++------ doc/disorder-stats.8.in | 16 +++++++-------- doc/disorder.1.in | 40 ++++++++++++++++++------------------- doc/disorder_config.5.in | 32 ++++++++++++++--------------- doc/disorder_protocol.5.in | 20 +++++++++---------- doc/disorderd.8.in | 18 ++++++++--------- doc/disorderfm.1.in | 30 ++++++++++++++-------------- doc/tkdisorder.1 | 4 ++-- 16 files changed, 178 insertions(+), 178 deletions(-) diff --git a/doc/disobedience.1.in b/doc/disobedience.1.in index b6c3f73..e82ea3b 100644 --- a/doc/disobedience.1.in +++ b/doc/disobedience.1.in @@ -282,45 +282,45 @@ Brings up the \fBLogin Details Window\fR. Quit. .SH "NETWORK PLAY" Network play uses a background -.BR disorder-playrtp (1) +.BR disorder\-playrtp (1) process. If you quit Disobedience the player will continue playing and can be disabled from a later run of Disobedience. .PP The player will log to -.I ~/.disorder/HOSTNAME-rtp.log +.I ~/.disorder/HOSTNAME\-rtp.log so look there if it does not seem to be working. .PP You can stop it without running Disobedience by the command -.BR "killall disorder-playrtp" . +.BR "killall disorder\-playrtp" . .SH OPTIONS .TP -.B --config \fIPATH\fR, \fB-c \fIPATH +.B \-\-config \fIPATH\fR, \fB\-c \fIPATH Set the configuration file. The default is .IR pkgconfdir/config . .TP -.B --debug\fR, \fB-d +.B \-\-debug\fR, \fB\-d Enable debugging. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SS "GTK+ Options" Additional options are supported by the GTK+ library. Refer to GTK+ documentation for further information. Under X11 they include: .TP -.B --display \fIDISPLAY\fR +.B \-\-display \fIDISPLAY\fR The X display to use. .TP -.B --screen \fISCREEN\fR +.B \-\-screen \fISCREEN\fR The screen number to use. .\" If know enough to use it you know enough to find it .\" .TP -.\" .B --sync +.\" .B \-\-sync .\" Make all X requests synchronously. .SH CONFIGURATION If you are using @@ -343,25 +343,25 @@ There are bound to be bugs. Please send feedback. .PP There is no particular provision for multiple users of the same computer -sharing a single \fBdisorder-playrtp\fR process. +sharing a single \fBdisorder\-playrtp\fR process. This shouldn't be too much of a problem in practice but something could perhaps be done given demand. .SH FILES .TP -.I ~/.disorder/HOSTNAME-rtp +.I ~/.disorder/HOSTNAME\-rtp Socket for communication with RTP player. .TP -.I ~/.disorder/HOSTNAME-rtp.log +.I ~/.disorder/HOSTNAME\-rtp.log Log file for RTP player. .SH "SEE ALSO" -.BR disorder-playrtp (1), +.BR disorder\-playrtp (1), .BR disorder_config (5) .PP .B http://www.greenend.org.uk/rjk/disorder/ .br - DisOrder home page .PP -.B http://www.gtk.org/api/2.6/gtk/gtk-x11.html +.B http://www.gtk.org/api/2.6/gtk/gtk\-x11.html .br - Using GTK+ on the X Window System .\" Local Variables: diff --git a/doc/disorder-dbupgrade.8.in b/doc/disorder-dbupgrade.8.in index d7d8460..5824cc8 100644 --- a/doc/disorder-dbupgrade.8.in +++ b/doc/disorder-dbupgrade.8.in @@ -18,48 +18,48 @@ .\" .TH disorder-dbupgrade 8 .SH NAME -disorder-dbupgrade \- DisOrder Database Upgrader +disorder\-dbupgrade \- DisOrder Database Upgrader .SH SYNOPSIS -.B disorder-dbupgrade +.B disorder\-dbupgrade .RI [ OPTIONS ] .RI [ PATH ...] .SH DESCRIPTION -.B disorder-dbupgrade +.B disorder\-dbupgrade is DisOrder's database upgrader. It is invoked by DisOrder when necessary and does not normally need to be invoked manually. .SH OPTIONS .TP -.B --delete-bad-keys\fR, -x +.B \-\-delete\-bad\-keys\fR, \-x If invalid keys are found in the database then delete them. See .B "INVALID KEYS" below. .TP -.B --fail-bad-keys\fR, -X +.B \-\-fail\-bad\-keys\fR, \-X If invalid keys are found in the database then fail. See .B "INVALID KEYS" below. .TP -.B --config \fIPATH\fR, \fB-c \fIPATH +.B \-\-config \fIPATH\fR, \fB\-c \fIPATH Set the configuration file. .TP -.B --debug\fR, \fB-d +.B \-\-debug\fR, \fB\-d Enable debugging. .TP -.B --syslog +.B \-\-syslog Log to syslog. This is the default if stderr is not a terminal. .TP -.B --no-syslog +.B \-\-no\-syslog Do not log to syslog. This is the default if stderr is a terminal. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SH "INVALID KEYS" An invalid key is one that is not valid UTF-8 or cannot be converted @@ -67,7 +67,7 @@ to NFC for some reason. By default a warning message is issued and they are left in the database (if doing so will not compromise its integrity). The -.B -x +.B \-x option can be used to delete them if they are known to be harmless. .SH "SEE ALSO" \fBdisorderd\fR(8), \fBdisorder_config\fR(5) diff --git a/doc/disorder-deadlock.8.in b/doc/disorder-deadlock.8.in index 7f7ad24..175b570 100644 --- a/doc/disorder-deadlock.8.in +++ b/doc/disorder-deadlock.8.in @@ -18,35 +18,35 @@ .\" .TH disorder-deadlock 8 .SH NAME -disorder-deadlock \- DisOrder deadlock manager +disorder\-deadlock \- DisOrder deadlock manager .SH SYNOPSIS -.B disorder-deadlock +.B disorder\-deadlock .RI [ OPTIONS ] .SH DESCRIPTION -.B disorder-deadlock +.B disorder\-deadlock is DisOrder's deadlock manager. It is automatically started by the server and does not need to be invoked manually. .SH OPTIONS .TP -.B --config \fIPATH\fR, \fB-c \fIPATH +.B \-\-config \fIPATH\fR, \fB\-c \fIPATH Set the configuration file. .TP -.B --debug\fR, \fB-d +.B \-\-debug\fR, \fB\-d Enable debugging. .TP -.B --syslog +.B \-\-syslog Log to syslog. This is the default if stderr is not a terminal. .TP -.B --no-syslog +.B \-\-no\-syslog Do not log to syslog. This is the default if stderr is a terminal. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SH "SEE ALSO" \fBdisorderd\fR(8), \fBdisorder_config\fR(5) diff --git a/doc/disorder-decode.8.in b/doc/disorder-decode.8.in index 32700f3..57c2a6d 100644 --- a/doc/disorder-decode.8.in +++ b/doc/disorder-decode.8.in @@ -21,10 +21,10 @@ .SH NAME disorder-decode \- DisOrder audio decoder .SH SYNOPSIS -.B disorder-decode +.B disorder\-decode .I PATH .SH DESCRIPTION -.B disorder-decode +.B disorder\-decode converts MP3, OGG, FLAC and WAV files into DisOrders "raw" format. It is therefore suitable for use as an .B execraw @@ -33,10 +33,10 @@ player. It is not intended to be used from the command line. .SH OPTIONS .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SH LIMITATIONS OGG files with multiple bitstreams are not supported. diff --git a/doc/disorder-dump.8.in b/doc/disorder-dump.8.in index 0f13bc8..9d5f387 100644 --- a/doc/disorder-dump.8.in +++ b/doc/disorder-dump.8.in @@ -18,57 +18,57 @@ .\" .TH disorder-dump 8 .SH NAME -disorder-dump \- DisOrder dump/undump tool +disorder\-dump \- DisOrder dump/undump tool .SH SYNOPSIS -.B disorder-dump +.B disorder\-dump .RI [ OPTIONS ] -.BR --dump | --undump +.BR \-\-dump | \-\-undump .I PATH .br -.B disorder-dump +.B disorder\-dump .RI [ OPTIONS ] -.BR --recompute-aliases +.BR \-\-recompute\-aliases .SH DESCRIPTION -.B disorder-dump +.B disorder\-dump is used to dump and restore preferences data. .SH OPTIONS .TP -.B --dump +.B \-\-dump Write preferences data to \fIPATH\fR. This can safely be used whether or not the server is running. .TP -.B --undump +.B \-\-undump Read preferences data from \fIPATH\fR, replacing (unrecoverably) the current settings. This should normally only be done while the server is not running. .IP If the server is running then it may hang while the undump completes. .TP -.B --recover +.B \-\-recover Perform database recovery at startup. The server should not be running if this option is used. .TP -.B --recompute-aliases +.B \-\-recompute\-aliases Recompute aliases without dumping or undumping the databases. Under normal circumstances this is never necessary. .TP -.B --remove-pathless +.B \-\-remove\-pathless Remove tracks with no associated path when undumping or when recomputing aliases. In normal use such tracks are all aliases. .TP -.B --config \fIPATH\fR, \fB-c \fIPATH +.B \-\-config \fIPATH\fR, \fB\-c \fIPATH Set the configuration file. The default is .IR /etc/disorder/config . .TP -.B --debug\fR +.B \-\-debug\fR Enable debugging. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SH NOTES This program might be used for a number of purposes: @@ -81,7 +81,7 @@ Indoctrinating one DisOrder server with the preference values of another. .PP The output file is versioned, so versions produced from a future -version of DisOrder may be rejected by \fB--undump\fR. +version of DisOrder may be rejected by \fB\-\-undump\fR. It has an end marker so truncated inputs will also be rejected. .PP The input or output file must be a regular file, as it may be rewound @@ -94,7 +94,7 @@ anything else accessing the databases. The server performs normal database recovery on startup. However if the database needs normal recovery before an undump can succeed and you don't want to start the server for some reason then the -.B --recover +.B \-\-recover operation is available for this purpose. No other process should be accessing the database at the time. .PP diff --git a/doc/disorder-normalize.8 b/doc/disorder-normalize.8 index 9db6650..b68619d 100644 --- a/doc/disorder-normalize.8 +++ b/doc/disorder-normalize.8 @@ -20,33 +20,33 @@ .SH NAME disorder-normalize \- DisOrder audio normalization process .SH SYNOPSIS -.B disorder-normalize +.B disorder\-normalize .SH DESCRIPTION -.B disorder-normalize +.B disorder\-normalize is used by .BR disorderd (8) to convert audio data to a consistent encoding. It is not intended to be used by ordinary users. .SH OPTIONS .TP -.B --config \fIPATH\fR, \fB-c \fIPATH +.B \-\-config \fIPATH\fR, \fB\-c \fIPATH Set the configuration file. .TP -.B --debug\fR, \fB-d +.B \-\-debug\fR, \fB\-d Enable debugging. .TP -.B --syslog +.B \-\-syslog Log to syslog. This is the default if stderr is not a terminal. .TP -.B --no-syslog +.B \-\-no\-syslog Do not log to syslog. This is the default if stderr is a terminal. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SH "SEE ALSO" .BR disorderd (8) diff --git a/doc/disorder-playrtp.1.in b/doc/disorder-playrtp.1.in index 16d128a..7b4e1d1 100644 --- a/doc/disorder-playrtp.1.in +++ b/doc/disorder-playrtp.1.in @@ -20,13 +20,13 @@ .SH NAME disorder-playrtp \- play DisOrder network broadcasts .SH SYNOPSIS -.B disorder-playrtp +.B disorder\-playrtp .RI [ OPTIONS ] -.RB [ -- ] +.RB [ \-\- ] .RI [[ GROUP ] .IR PORT ] .SH DESCRIPTION -\fBdisorder-playrtp\fR plays a network broadcast sent from the specified +\fBdisorder\-playrtp\fR plays a network broadcast sent from the specified address. .PP If neither a group nor port are specified then the local DisOrder @@ -42,61 +42,61 @@ multicast to that group and port. The default sound API is the first of the ones listed below that are available. Usually this implies ALSA under Linux and Core Audio under OS X. .TP -.B --alsa\fR, \fB-a +.B \-\-alsa\fR, \fB-\a Use ALSA to play sound. .TP -.B --oss\fR, \fB-o +.B \-\-oss\fR, \fB\-o Use OSS to play sound. .TP -.B --core-audio\fR, \fB-c +.B \-\-core\-audio\fR, \fB\-c Use Core Audio to play sound. .TP -.B --device \fIDEVICE\fR, \fB-D \fIDEVICE\fR +.B \-\-device \fIDEVICE\fR, \fB\-D \fIDEVICE\fR Specifies the audio device to use. The exact meaning of this is platform-dependent; on Linux it is the ALSA device name. .TP -.B --config \fIPATH\fR, \fB-C \fIPATH +.B \-\-config \fIPATH\fR, \fB\-C \fIPATH Set the configuration file. The default is .IR pkgconfdir/config . .TP -.B --socket \fIPATH\fR, \fB-s \fIPATH +.B \-\-socket \fIPATH\fR, \fB\-s \fIPATH Set the control socket. Normally this would not be used manually. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SS "Buffer Control Options" You shouldn't need to use these options. .TP -.B --min \fIFRAMES\fR, \fB-m \fIFRAMES\fR +.B \-\-min \fIFRAMES\fR, \fB\-m \fIFRAMES\fR Specifies the buffer low watermark in frames. If the number of frames falls below this value then playing will be stopped until the buffer fills up. .TP -.B --buffer \fIFRAMES\fR, \fB-b \fIFRAMES\fR +.B \-\-buffer \fIFRAMES\fR, \fB\-b \fIFRAMES\fR Specifies the buffer high watermark in frames. Once there are this many frames in the buffer, playing will be (re-)started. .TP -.B --max \fIFRAMES\fR, \fB-x \fIFRAMES\fR +.B \-\-max \fIFRAMES\fR, \fB\-x \fIFRAMES\fR Specifies the maximum buffer size in frames. If there are this many frames in the buffer then reading from the network socket will be suspended. -The default is four times the \fB--buffer\fR value. +The default is four times the \fB\-\-buffer\fR value. .TP -.B --rcvbuf \fIBYTES\fR, \fB-R \fIBYTES\fR +.B \-\-rcvbuf \fIBYTES\fR, \fB\-R \fIBYTES\fR Specifies socket receive buffer size. The default is 131072 (128Kbytes). The buffer size will not be reduced below the operating system's default. .SH "REMOTE CONTROL" The -.B --socket +.B \-\-socket option is used by Disobedience to control a background -.B disorder-playrtp +.B disorder\-playrtp daemon. The socket will be created as a UNIX domain stream socket. When a connection is received a single line is read from it. @@ -104,7 +104,7 @@ The following commands are known: .TP .B stop Causes -.B disorder-playrtp +.B disorder\-playrtp to terminate. .TP .B query diff --git a/doc/disorder-rescan.8.in b/doc/disorder-rescan.8.in index bfcf307..63ed7d7 100644 --- a/doc/disorder-rescan.8.in +++ b/doc/disorder-rescan.8.in @@ -20,34 +20,34 @@ .SH NAME disorder-rescan \- DisOrder rescanner .SH SYNOPSIS -.B disorder-rescan +.B disorder\-rescan .RI [ OPTIONS ] .RI [ PATH ...] .SH DESCRIPTION -.B disorder-rescan +.B disorder\-rescan is DisOrder's database rescanner. It is invoked by DisOrder when necessary and does not need to be invoked manually. .SH OPTIONS .TP -.B --config \fIPATH\fR, \fB-c \fIPATH +.B \-\-config \fIPATH\fR, \fB\-c \fIPATH Set the configuration file. .TP -.B --debug\fR, \fB-d +.B \-\-debug\fR, \fB\-d Enable debugging. .TP -.B --syslog +.B \-\-syslog Log to syslog. This is the default if stderr is not a terminal. .TP -.B --no-syslog +.B \-\-no\-syslog Do not log to syslog. This is the default if stderr is a terminal. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SH "SEE ALSO" \fBdisorderd\fR(8), \fBdisorder_config\fR(5) diff --git a/doc/disorder-speaker.8 b/doc/disorder-speaker.8 index 0963983..6b1d0bb 100644 --- a/doc/disorder-speaker.8 +++ b/doc/disorder-speaker.8 @@ -30,24 +30,24 @@ tracks. It is not intended for direct invocation. .SH OPTIONS .TP -.B --config \fIPATH\fR, \fB-c \fIPATH +.B \-\-config \fIPATH\fR, \fB\-c \fIPATH Set the configuration file. .TP -.B --debug\fR, \fB-d +.B \-\-debug\fR, \fB\-d Enable debugging. .TP -.B --syslog +.B \-\-syslog Log to syslog. This is the default if stderr is not a terminal. .TP -.B --no-syslog +.B \-\-no-syslog Do not log to syslog. This is the default if stderr is a terminal. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SH "SEE ALSO" .BR disorderd (8) diff --git a/doc/disorder-stats.8.in b/doc/disorder-stats.8.in index 683da7e..8dffb71 100644 --- a/doc/disorder-stats.8.in +++ b/doc/disorder-stats.8.in @@ -20,32 +20,32 @@ .SH NAME disorder-stats \- DisOrder statistics .SH SYNOPSIS -.B disorder-stats +.B disorder\-stats .RI [ OPTIONS ] .SH DESCRIPTION -.B disorder-stats +.B disorder\-stats reports server statistics. It is used by the server and would not normally be invoked manually. .SH OPTIONS .TP -.B --config \fIPATH\fR, \fB-c \fIPATH +.B \-\-config \fIPATH\fR, \fB\-c \fIPATH Set the configuration file. .TP -.B --debug\fR, \fB-d +.B \-\-debug\fR, \fB\-d Enable debugging. .TP -.B --syslog +.B \-\-syslog Log to syslog. This is the default if stderr is not a terminal. .TP -.B --no-syslog +.B \-\-no\-syslog Do not log to syslog. This is the default if stderr is a terminal. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SH "SEE ALSO" \fBdisorderd\fR(8), \fBdisorder_config\fR(5) diff --git a/doc/disorder.1.in b/doc/disorder.1.in index 142ab70..d77a62b 100644 --- a/doc/disorder.1.in +++ b/doc/disorder.1.in @@ -22,7 +22,7 @@ disorder \- DisOrder jukebox client .SH SYNOPSIS .B disorder .RI [ OPTIONS ] -.RB [ -- ] +.RB [ \-\- ] .RI [ COMMANDS ...] .SH DESCRIPTION .B disorder @@ -37,21 +37,21 @@ This can be used to test whether the daemon is running. Otherwise, it executes the commands specified. .SH OPTIONS .TP -.B --config \fIPATH\fR, \fB-c \fIPATH +.B \-\-config \fIPATH\fR, \fB\-c \fIPATH Set the configuration file. The default is .IR pkgconfdir/config . .TP -.B --debug\fR, \fB-d +.B \-\-debug\fR, \fB\-d Enable debugging. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .TP -.B --help-commands\fR, \fB-H +.B \-\-help\-commands\fR, \fB\-H List all known commands. .SH COMMANDS .TP @@ -100,10 +100,10 @@ Only files with a basename matching the regexp will be returned. .B get \fITRACK\fR \fIKEY\fR Display the preference \fIKEY\fR for \fITRACK\fR. .TP -.B get-global \fIKEY\fR +.B get\-global \fIKEY\fR Get a global preference. .TP -.B get-volume +.B get\-volume Display the current volume settings. .TP .B length \fITRACK\fR @@ -123,7 +123,7 @@ Positive values move towards the head of the queue, negative values towards the tail. .IP Note that if you specify a negative value then the -.B -- +.B \-\- option separate (before all commands) becomes mandatory, as otherwise the negative value is misinterpreted an an option. .TP @@ -151,10 +151,10 @@ Display all the preferences for \fITRACK\fR. List the current queue. The first entry in the list is the next track to play. .TP -.B random-disable +.B random\-disable Disable random play. .TP -.B random-enable +.B random\-enable Enable random play. .TP .B recent @@ -179,13 +179,13 @@ Resolve aliases for \fITRACK\fR and print out the real track name. .B resume Resume the current track after a pause. .TP -.B rtp-address +.B rtp\-address Report the RTP brodcast address used by the server (if any). .TP .B scratch Scratch the currently playing track. .TP -.B scratch-id \fIID\fR +.B scratch\-id \fIID\fR Scratch the currently playing track, provided it has the given ID. .TP .B search \fITERMS\fR @@ -204,19 +204,19 @@ For example: .B set \fITRACK\fR \fIKEY\fR \fIVALUE\fR Set the preference \fIKEY\fR for \fITRACK\fR to \fIVALUE\fR. .TP -.B set-global \fIKEY\fR \fIVALUE\fR +.B set\-global \fIKEY\fR \fIVALUE\fR Set a global preference. .TP -.B set-volume \fBLEFT\fR \fBRIGHT\fR +.B set\-volume \fBLEFT\fR \fBRIGHT\fR Set the volume. .TP -.B setup-guest \fR[\fB--no-online-registration\fR] +.B setup\-guest \fR[\fB\-\-no\-online\-registration\fR] Create the "guest" user for use by the web interface. This user will have no password and will only have the "read" and "register" rights, the latter allowing new users to automatically register themselves via the web interface. .IP -With the option \fB--no-online-registration\fR, the "register" right is +With the option \fB\-\-no-online\-registration\fR, the "register" right is suppressed and users must be manually created by an administrator. .IP If online registration is desired then \fBmail_sender\fR must be set in the @@ -235,7 +235,7 @@ List known tags. .B unset \fITRACK\fR \fIKEY\fR Unset the preference \fIKEY\fR for \fITRACK\fR. .TP -.B unset-global \fIKEY\fR +.B unset\-global \fIKEY\fR Unset the global preference \fIKEY\fR. .TP .B userinfo \fIUSER PROPERTY @@ -284,9 +284,9 @@ Tags can contain any printing character except comma. Leading and trailing spaces are not significant but internal spaces are. .IP Using the -.B required-tags +.B required\-tags and -.B prohibited-tags +.B prohibited\-tags global preferences, it is possible to limit the tracks that will be selected at random. .TP diff --git a/doc/disorder_config.5.in b/doc/disorder_config.5.in index 097feb8..3641adf 100644 --- a/doc/disorder_config.5.in +++ b/doc/disorder_config.5.in @@ -355,7 +355,7 @@ If no \fIMODULE\fR is specified then \fBfs\fR is assumed. .IP \fIENCODING\fR defines the encoding of filenames in this collection. For \fBfs\fR this would be the encoding you use for filenames. -Examples might be \fBiso-8859-1\fR or \fButf-8\fR. +Examples might be \fBiso\-8859\-1\fR or \fButf\-8\fR. If no encoding is specified then the current locale's character encoding is used. .IP @@ -509,20 +509,20 @@ The maximum days that a track can survive in the database of newly added tracks. The default is 31. .TP -.B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB--\fR]] \fIARGS\fR... +.B player \fIPATTERN\fR \fIMODULE\fR [\fIOPTIONS.. [\fB\-\-\fR]] \fIARGS\fR... Specifies the player for files matching the glob \fIPATTERN\fR. \fIMODULE\fR specifies which plugin module to use. .IP The following options are supported: .RS .TP -.B --wait-for-device\fR[\fB=\fIDEVICE\fR] +.B \-\-wait\-for\-device\fR[\fB=\fIDEVICE\fR] Waits (for up to a couple of seconds) for the default, or specified, libao device to become openable. .TP -.B -- +.B \-\- Defines the end of the list of options. -Needed if the first argument to the plugin starts with a "-". +Needed if the first argument to the plugin starts with a "\-". .RE .IP The following are the standard modules: @@ -621,8 +621,8 @@ Signals are specified by their full C name, i.e. \fBSIGINT\fR and not \fBINT\fR or \fBInterrupted\fR or whatever. .TP .B sox_generation \fB0\fR|\fB1 -Determines whether calls to \fBsox\fR(1) should use \fB-b\fR, \fB-x\fR, etc (if -the generation is 0) or \fB-\fIbits\fR, \fB-L\fR etc (if it is 1). +Determines whether calls to \fBsox\fR(1) should use \fB\-b\fR, \fB\-x\fR, etc (if +the generation is 0) or \fB\-\fIbits\fR, \fB\-L\fR etc (if it is 1). See the documentation for your installed copy of \fBsox\fR to determine which you need. The default is 0. @@ -760,13 +760,13 @@ Specify password. Specify username. The default is taken from the environment variable \fBLOGNAME\fR. .SH "GLOBAL PREFERENCES" -These are the values set with \fBset-global\fR. +These are the values set with \fBset\-global\fR. .TP -.B required-tags +.B required\-tags If this is set an nonempty then randomly played tracks will always have at least one of the listed tags. .TP -.B prohibited-tags +.B prohibited\-tags If this is set an nonempty then randomly played tracks will never have any of the listed tags. .TP @@ -775,7 +775,7 @@ If unset or \fByes\fR then play is enabled. Otherwise it is disabled. Use \fBdisable\fR rather than setting it directly. .TP -.B random-play +.B random\-play If unset or \fByes\fR then random play is enabled. Otherwise it is disabled. Use \fBdisable\fR rather than setting it directly. @@ -1122,7 +1122,7 @@ Expands \fITEMPLATE\fR repeatedly using the each track on the queue in turn as the current track. The track at the head of the queue comes first. .TP -.B @random-enabled@ +.B @random\-enabled@ Expands to \fBtrue\fR if random play is currently enabled, otherwise to \fBfalse\fR. .TP @@ -1168,7 +1168,7 @@ Usually you want \fBdisplay\fR for everything except the title and If you use \fBsort\fR for artist and album then you are likely to get strange effects. .TP -.B @server-version@ +.B @server\-version@ Expands to the server's version string. .TP .B @shell{\fICOMMAND\fB}@ @@ -1376,10 +1376,10 @@ Expands the \fBplaying.html\fR template rather than redirecting. .IP This is the default if \fBaction\fR is missing. .TP -.B "random-disable" +.B "random\-disable" Disables random play. .TP -.B "random-enable" +.B "random\-enable" Enables random play. .TP .B "disable" @@ -1454,7 +1454,7 @@ In addition there are two built-in parts, \fBpath\fR which is the whole path name and \fBext\fR which is the filename extension, including the initial dot (or the empty string if there is not extension). .SH "SEE ALSO" -\fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder-dump\fR(8), +\fBdisorder\fR(1), \fBsox\fR(1), \fBdisorderd\fR(8), \fBdisorder\-dump\fR(8), \fBpcrepattern\fR(3) .\" Local Variables: .\" mode:nroff diff --git a/doc/disorder_protocol.5.in b/doc/disorder_protocol.5.in index aa6b65e..cc88541 100644 --- a/doc/disorder_protocol.5.in +++ b/doc/disorder_protocol.5.in @@ -69,7 +69,7 @@ Confirm user registration. This command can be used without logging in. .TP .B cookie \fICOOKIE -Log a user back in using a cookie created with \fBmake-cookie\fR. +Log a user back in using a cookie created with \fBmake\-cookie\fR. The response contains the username. .TP .B deluser \fIUSERNAME @@ -114,7 +114,7 @@ On success the second field of the response line will have the value. .IP If the track or preference do not exist then the response code is 555. .TP -.B get-global \fIKEY\fR +.B get\-global \fIKEY\fR Get a global preference. .IP If the preference does not exist then the response code is 555. @@ -131,7 +131,7 @@ i.e. it will not accumulate in a buffer somewhere). .IP See \fBEVENT LOG\fR below for more details. .TP -.B make-cookie +.B make\-cookie Returns an opaque string that can be used by the \fBcookie\fR command to log this user back in on another connection (until the cookie expires). .TP @@ -212,15 +212,15 @@ Send back the current queue in a response body, one track to a line, the track at the head of the queue (i.e. next to be be played) first. See below for the track information syntax. .TP -.B random-disable +.B random\-disable Disable random play (but don't stop the current track). Requires the \fBglobal prefs\fR right. .TP -.B random-enable +.B random\-enable Enable random play. Requires the \fBglobal prefs\fR right. .TP -.B random-enabled +.B random\-enabled Report whether random play is enabled. The second field of the response line will be \fByes\fR or \fBno\fR. .TP @@ -263,10 +263,10 @@ Resume the current track after a \fBpause\fR command. Requires the \fBpause\fR right. .TP .B revoke \fBcookie\fR -Revoke a cookie previously created with \fBmake-cookie\fR. +Revoke a cookie previously created with \fBmake\-cookie\fR. It will not be possible to use this cookie in the future. .TP -.B rtp-address +.B rtp\-address Report the RTP broadcast (or multicast) address, in the form \fIADDRESS PORT\fR. This command does not require authentication. @@ -299,7 +299,7 @@ allow searching for phrases. Set a preference. Requires the \fBprefs\fR right. .TP -.B set-global \fIKEY\fR \fIVALUE\fR +.B set\-global \fIKEY\fR \fIVALUE\fR Set a global preference. Requires the \fBglobal prefs\fR right. .TP @@ -313,7 +313,7 @@ Send the list of currently known tags in a response body. Unset a preference. Requires the \fBprefs\fR right. .TP -.B \fBunset-global\fR \fIKEY\fR +.B \fBunset\-global\fR \fIKEY\fR Unset a global preference. Requires the \fBglobal prefs\fR right. .TP diff --git a/doc/disorderd.8.in b/doc/disorderd.8.in index 01802b3..73bfba4 100644 --- a/doc/disorderd.8.in +++ b/doc/disorderd.8.in @@ -28,7 +28,7 @@ is a daemon which plays audio files and services requests from users concerning what is to be played. .SH OPTIONS .TP -.B --config \fIPATH\fR, \fB-c \fIPATH +.B \-\-config \fIPATH\fR, \fB\-c \fIPATH Set the configuration file. The default is .IR pkgconfdir/config . @@ -36,26 +36,26 @@ See .BR disorder_config (5) for further information. .TP -.B --pidfile \fIPATH\fR, \fB-P \fIPATH +.B \-\-pidfile \fIPATH\fR, \fB\-P \fIPATH Write a pidfile. .TP -.B --foreground\fR, \fB-f +.B \-\-foreground\fR, \fB\-f Run in the foreground. (By default, .B disorderd detaches from its terminal and runs in the background.) .TP -.B --syslog\fR, \fB-s +.B \-\-syslog\fR, \fB\-s Log to syslog. This is the default if DisOrder runs in the background. .TP -.B --debug\fR, \fB-d +.B \-\-debug\fR, \fB\-d Enable debugging. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SH NOTES For configuration file documentation, see @@ -93,7 +93,7 @@ recovery can be used, and indeed the server does this automatically on startup). .PP It is suggested that instead you just back up the output of -.BR disorder-dump (8), +.BR disorder\-dump (8), which saves only the parts of the database that cannot be regenerated automatically, and thus has relatively modest storage requirements. .SH SIGNALS @@ -165,7 +165,7 @@ This prevents multiple instances of DisOrder running simultaneously. Current locale. See \fBlocale\fR(7). .SH "SEE ALSO" -\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder-dump\fR(8) +\fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorder\-dump\fR(8) .\" Local Variables: .\" mode:nroff .\" End: diff --git a/doc/disorderfm.1.in b/doc/disorderfm.1.in index a647aa6..8727d1e 100644 --- a/doc/disorderfm.1.in +++ b/doc/disorderfm.1.in @@ -36,19 +36,19 @@ This program is not well-tested! .SH OPTIONS .SS "Filename Format" .TP -.B --from\fI ENCODING\fR, \fB-f\fI ENCODING +.B \-\-from\fI ENCODING\fR, \fB\-f\fI ENCODING Specifies the filename encoding used below .IR SOURCE . .TP -.B --to\fI ENCODING\fR, \fB-t\fI ENCODING +.B \-\-to\fI ENCODING\fR, \fB\-t\fI ENCODING Specifies the filename encoding used below .IR DESTINATION . .PP -If neither of \fB--from\fR or \fB--to\fR are specified then no encoding +If neither of \fB\-\-from\fR or \fB\-\-to\fR are specified then no encoding translation is performed. If only one is specified then the other is set to the current locale. .TP -.B --windows-friendly\fR, \fB-w +.B \-\-windows\-friendly\fR, \fB\-w Specifies that filenames below .I DESTINATION must be Windows-friendly. @@ -57,45 +57,45 @@ device names with '_' and stripping trailing dots and spaces. .SS "File Selection" .TP -.B --include\fI PATTERN\fR, \fB-i\fI PATTERN +.B \-\-include\fI PATTERN\fR, \fB\-i\fI PATTERN Include filenames matching the glob pattern \fIPATTERN\fR. .TP -.B --exclude\fI PATTERN\fR, \fB-e\fI PATTERN +.B \-\-exclude\fI PATTERN\fR, \fB\-e\fI PATTERN Exclude filenames matching the glob pattern \fIPATTERN\fR. .PP These options may be used more than once. They will be checked in order and the first that matches any given filename will determine whether that file is included or excluded. .PP -If none of the options match and \fB--include\fR was used at all then the file +If none of the options match and \fB\-\-include\fR was used at all then the file is excluded. -If none of the options match and \fB--include\fR was never used then the file +If none of the options match and \fB\-\-include\fR was never used then the file is included. .SS "File Copying" .TP -.B --link\fR, \fB-l +.B \-\-link\fR, \fB\-l Files are hard-linked to their destination location. This is the default action. .TP -.B --symlink\fR, \fB-s +.B \-\-symlink\fR, \fB\-s Symlinks are made in the destination location pointing back into the source directory. .TP -.B --copy\fR, \fB-c +.B \-\-copy\fR, \fB\-c Files are copied into their destination location. .TP -.B --no-action\fR, \fB-n +.B \-\-no\-action\fR, \fB\-n The destination location is not modified in any way. Instead a report is written to standard output saying what would be done. .SS "Other" .TP -.B --debug\fR, \fB-d +.B \-\-debug\fR, \fB\-d Enable debugging. .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .\" Local Variables: .\" mode:nroff diff --git a/doc/tkdisorder.1 b/doc/tkdisorder.1 index 390032b..8cd1b68 100644 --- a/doc/tkdisorder.1 +++ b/doc/tkdisorder.1 @@ -49,10 +49,10 @@ The bottom half of the window lists the current queue, with the next track to be played at the top. .SH OPTIONS .TP -.B --help\fR, \fB-h +.B \-\-help\fR, \fB\-h Display a usage message. .TP -.B --version\fR, \fB-V +.B \-\-version\fR, \fB\-V Display version number. .SH "SEE ALSO" \fBdisorder\fR(1), \fBdisobedience\fR(1), \fBdisorder_config\fR(5) -- [mdw]