From ca5f8cbcfec205ac679e76b569b51990f368390b Mon Sep 17 00:00:00 2001 From: Nicolas FRANCOIS Date: Fri, 8 Oct 2004 16:15:34 +0000 Subject: [PATCH] Fix hyphens in man pages This patch converts hyphens to minus signs in the man pages (for options, emails, or command line examples). This patch also closes one font modifier in iecset.1. (s/\fIfalse\fI,/\fIfalse\fP,/) Signed-off-by: Nicolas FRANCOIS --- alsaconf/alsaconf.8 | 6 ++--- alsactl/alsactl.1 | 14 +++++----- alsamixer/alsamixer.1 | 12 ++++----- amidi/amidi.1 | 52 +++++++++++++++++------------------ amixer/amixer.1 | 18 ++++++------- aplay/aplay.1 | 54 ++++++++++++++++++------------------- iecset/iecset.1 | 14 +++++----- seq/aconnect/aconnect.1 | 30 ++++++++++----------- seq/aplaymidi/aplaymidi.1 | 12 ++++----- seq/aplaymidi/arecordmidi.1 | 26 +++++++++--------- seq/aseqnet/aseqnet.1 | 2 +- 11 files changed, 120 insertions(+), 120 deletions(-) diff --git a/alsaconf/alsaconf.8 b/alsaconf/alsaconf.8 index 651fcee..9ce70bb 100644 --- a/alsaconf/alsaconf.8 +++ b/alsaconf/alsaconf.8 @@ -52,7 +52,7 @@ Set the device mode for the ALSA devices (default = 0666). This option is obsolete in the recent ALSA version. .TP .B \-r, \-\-strict -Set strict device mode (equiv. with -g 17 -d 0660). +Set strict device mode (equiv. with \-g 17 \-d 0660). This option is obsolete in the recent ALSA version. .TP .B \-L, \-\-log file @@ -79,7 +79,7 @@ In Debian, the default gid of the device files is 29 (corresponding to the audio group) and the default device mode is 0660. For the ALSA base package, see also -.I /usr/share/doc/alsa-base/ +.I /usr/share/doc/alsa\-base/ .SH SEE ALSO \fB @@ -90,7 +90,7 @@ arecord(1) \fP .SH HOMEPAGE -http://www.alsa-project.org/ +http://www.alsa\-project.org/ .SH AUTHOR The alsaconf script was written by diff --git a/alsactl/alsactl.1 b/alsactl/alsactl.1 index f5d4d1a..36d3f3e 100644 --- a/alsactl/alsactl.1 +++ b/alsactl/alsactl.1 @@ -29,29 +29,29 @@ loaded. .SS Options .TP -\fI-h, --help\fP +\fI\-h, \-\-help\fP Help: show available flags and commands. .TP -\fI-f, --file\fP +\fI\-f, \-\-file\fP Select the configuration file to use. The default is /etc/asound.state .TP -\fI-F, --force\fP +\fI\-F, \-\-force\fP Used with restore command. Try to restore the matching control elements as much as possible. .TP -\fI-d, --debug\fP +\fI\-d, \-\-debug\fP Use debug mode: a bit more verbose. .TP -\fI-v, --version\fP +\fI\-v, \-\-version\fP Print alsactl version number. .SH FILES \fI/etc/asound.state\fP (or whatever file you specify with the -\fB-f\fP flag) is used to store current settings for your +\fB\-f\fP flag) is used to store current settings for your soundcards. The settings include all the usual soundcard mixer settings. More importantly, alsactl is capable of controlling other card-specific features that mixer apps @@ -75,4 +75,4 @@ None known. .SH AUTHOR \fBalsactl\fP is by Jaroslav Kysela and Abramo Bagnara -. This document is by Paul Winkler . +. This document is by Paul Winkler . diff --git a/alsamixer/alsamixer.1 b/alsamixer/alsamixer.1 index 42dddc0..63b38ef 100644 --- a/alsamixer/alsamixer.1 +++ b/alsamixer/alsamixer.1 @@ -16,24 +16,24 @@ soundcard drivers. It supports multiple soundcards with multiple devices. .SS Options .TP -\fI-h, -help\fP +\fI\-h, \-help\fP Help: show available flags. .TP -\fI-c\fP +\fI\-c\fP Select the soundcard to use, if you have more than one. Cards are numbered from 0 (the default). .TP -\fI-D\fP +\fI\-D\fP Select the mixer device to control. .TP -\fI-g\fP +\fI\-g\fP Toggle the using of colors. .TP -\fI-s\fP +\fI\-s\fP Minimize the mixer window. .SH KEYBOARD COMMANDS @@ -49,7 +49,7 @@ channel (or device, depending on your preferred terminology). You can also use \fIn\fP ("next") and \fIp\fP ("previous"). The \fIUp\fP and \fIDown Arrows\fP control the volume for the -currently selected device. You can also use \fI+\fP or \fI-\fP for the +currently selected device. You can also use \fI+\fP or \fI\-\fP for the same purpose. Both the left and right signals are affected. For independent left and right control, see below. diff --git a/amidi/amidi.1 b/amidi/amidi.1 index 810e652..cfde44c 100644 --- a/amidi/amidi.1 +++ b/amidi/amidi.1 @@ -28,41 +28,41 @@ do. .I options Use the -.I -h, -.I -V, -.I -l, +.I \-h, +.I \-V, +.I \-l, or -.I -L +.I \-L options to display information; or use at least one of the -.I -s, -.I -r, -.I -S, +.I \-s, +.I \-r, +.I \-S, or -.I -d +.I \-d options to specify what data to send or receive. .SS Options .TP -.I -h, --help +.I \-h, \-\-help Help: prints a list of options. .TP -.I -V, --version +.I \-V, \-\-version Prints the current version. .TP -.I -l, --list-devices +.I \-l, \-\-list\-devices Prints a list of all hardware MIDI ports. .TP -.I -L, --list-rawmidis +.I \-L, \-\-list\-rawmidis Prints all RawMIDI definitions. (used when debugging configuration files) .TP -.I -p, --port=name +.I \-p, \-\-port=name Sets the name of the ALSA RawMIDI port to use. If this is not specified, .B amidi @@ -70,14 +70,14 @@ uses the default port defined in the configuration file (the default for this is port 0 on card 0, which may not exist). .TP -.I -s, --send=filename +.I \-s, \-\-send=filename Sends the contents of the specified file to the MIDI port. The file must contain raw MIDI commands (e.g. a .syx file); for Standard MIDI (.mid) files, use .B aplaymidi(1). .TP -.I -r, --receive=filename +.I \-r, \-\-receive=filename Writes data received from the MIDI port into the specified file. The file will contain raw MIDI commands (such as in a .syx file); to record a Standard MIDI (.mid) file, use @@ -85,24 +85,24 @@ to record a Standard MIDI (.mid) file, use .B amidi will filter out any Active Sensing bytes (FEh), unless the -.I -a +.I \-a option has been given. .TP -.I -S, --send-hex="..." +.I \-S, \-\-send\-hex="..." Sends the bytes specified as hexadecimal numbers to the MIDI port. .TP -.I -d, --dump +.I \-d, \-\-dump Prints data received from the MIDI port as hexadecimal bytes. Active Sensing bytes (FEh) will not be shown, unless the -.I -a +.I \-a option has been given. This option is useful for debugging. .TP -.I -t, --timeout=seconds +.I \-t, \-\-timeout=seconds Stops receiving data when no data has been received for the specified amount of time. @@ -111,25 +111,25 @@ If this option has not been given, you must press Ctrl+C (or kill to stop receiving data. .TP -.I -a, --active-sensing +.I \-a, \-\-active\-sensing Does not ignore Active Sensing bytes (FEh) when saving or printing received MIDI commands. .SH EXAMPLES .TP -.B amidi -p hw:0 -s my_settings.syx +.B amidi \-p hw:0 \-s my_settings.syx will send the MIDI commands in .I my_settings.syx to port .I hw:0. .TP -.B amidi -S 'F0 43 10 4C 00 00 7E 00 F7' +.B amidi \-S 'F0 43 10 4C 00 00 7E 00 F7' sends an XG Reset to the default port. .TP -.B amidi -p hw:1,2 -S F0411042110C000000000074F7 -r dump.syx -t 1 +.B amidi \-p hw:1,2 \-S F0411042110C000000000074F7 \-r dump.syx \-t 1 sends a \(lqParameter Dump Request\(rq to a GS device, saves the received parameter data to the file .I dump.syx, @@ -137,7 +137,7 @@ and stops after the device has finished sending data (when no data has been received for one second). .TP -.B amidi -p virtual -d +.B amidi \-p virtual \-d creates a virtual RawMIDI port and prints all data sent to this port. .SH FILES @@ -152,7 +152,7 @@ user specific rawmidi definitions .SH BUGS The -.I --list-devices +.I \-\-list\-devices option pretends that output and input ports are the same. .SH SEE ALSO diff --git a/amixer/amixer.1 b/amixer/amixer.1 index 96f33b0..a174006 100644 --- a/amixer/amixer.1 +++ b/amixer/amixer.1 @@ -2,7 +2,7 @@ .SH NAME amixer \- command-line mixer for ALSA soundcard driver .SH SYNOPSIS -\fBamixer\fP [\fI-c\fP card] [\fIcmd\fP] +\fBamixer\fP [\fI\-c\fP card] [\fIcmd\fP] .SH DESCRIPTION \fBamixer\fP allows command-line control of the mixer for the ALSA soundcard driver. @@ -38,7 +38,7 @@ either as a percentage from 0% to 100% or an exact hardware value. The parameters \fIcap, nocap, mute, unmute, toggle\fP are used to change capture (recording) and muting for the group specified. The parameters \fIfront, rear, center, woofer\fP are used to specify -channels to be changed. When plus(+) or minus(-) letter is appended after +channels to be changed. When plus(+) or minus(\-) letter is appended after volume value, the volume is incremented or decremented from the current value, respectively. @@ -74,28 +74,28 @@ the \fIcset\fP command. .SS Options .TP -[\fI-c\fP card] +[\fI\-c\fP card] Select the card number to control. The device name created from this parameter has syntax 'hw:N' where N is specified card number. .TP -[\fI-D\fP device] +[\fI\-D\fP device] Select the device name to control. The default control name is 'default'. .TP -\fI-h\fP +\fI\-h\fP Help: show syntax. .TP -\fI-q\fP +\fI\-q\fP Quiet mode. Do not show results of changes. .SS Example #1: .TP -\fBamixer -c 1 sset Line,0 80%,40% unmute cap\fR +\fBamixer \-c 1 sset Line,0 80%,40% unmute cap\fR will set the second soundcard's left line input volume to 80% and right line input to 40%, unmute it, and select it as a source for capture (recording).\fR @@ -104,14 +104,14 @@ capture (recording).\fR Example #2: .TP -\fBamixer -c 2 cset iface=MIXER,name='Line Playback Volume",index=1 40%\fR +\fBamixer \-c 2 cset iface=MIXER,name='Line Playback Volume",index=1 40%\fR will set the third soundcard's second line playback volume(s) to 40% .SS Example #3: .TP -\fBamixer -c 2 cset numid=34 40%\fR +\fBamixer \-c 2 cset numid=34 40%\fR will set the 34th soundcard element to 40% .SH BUGS diff --git a/aplay/aplay.1 b/aplay/aplay.1 index 6dead6f..9c14eb0 100644 --- a/aplay/aplay.1 +++ b/aplay/aplay.1 @@ -25,31 +25,31 @@ If filename is not specified, the standard output or input is used. The \fBaplay .SS Options .TP -\fI-h, --help\fP +\fI\-h, \-\-help\fP Help: show syntax. .TP -\fI--version\fP +\fI\-\-version\fP Print current version. .TP -\fI-l, --list-devices\fP +\fI\-l, \-\-list\-devices\fP List all soundcards and digital audio devices .TP -\fI-L, --list-pcms\fP +\fI\-L, \-\-list\-pcms\fP List all PCMs defined .TP -\fI-D, --device=NAME\fP +\fI\-D, \-\-device=NAME\fP Select PCM by name .TP -\fI-q --quiet\fP +\fI\-q \-\-quiet\fP Quiet mode. Suppress messages (not sound :)) .TP -\fI-t, --file-type TYPE\fP +\fI\-t, \-\-file\-type TYPE\fP File type (voc, wav, raw or au) .TP -\fI-c, --channels=#\fP +\fI\-c, \-\-channels=#\fP The number of channels .TP -\fI-f --format=FORMAT\fP +\fI\-f \-\-format=FORMAT\fP Sample format .br Recognized sample formats are: S8 U8 S16_LE S16_BE U16_LE U16_BE S24_LE @@ -61,67 +61,67 @@ Some of these may not be available on selected hardware .br There are also two format shortcuts available: .nf --f cd (16 bit little endian, 44100, stereo [-f S16_LE -c2 -r44100] --f dat (16 bit little endian, 48000, stereo) [-f S16_LE -c2 -r48000] +\-f cd (16 bit little endian, 44100, stereo [\-f S16_LE \-c2 \-r44100] +\-f dat (16 bit little endian, 48000, stereo) [\-f S16_LE \-c2 \-r48000] .fi .TP -\fI-r, --rate=#\fP +\fI\-r, \-\-rate=#\fP Sampling rate in Hertz. .TP -\fI-d, --duration=#\fP +\fI\-d, \-\-duration=#\fP Interrupt after # seconds. A value of zero means infinity. The default is zero, so if this option is omitted then the arecord process will run until it is killed. .TP -\fI-s, --sleep-min=#\fP +\fI\-s, \-\-sleep\-min=#\fP Min ticks to sleep .TP -\fI-M, --mmap\fP +\fI\-M, \-\-mmap\fP Mmap stream .TP -\fI-N, --nonblock\fP +\fI\-N, \-\-nonblock\fP Nonblocking mode .TP -\fI-F, --period-time=#\fP +\fI\-F, \-\-period\-time=#\fP Distance between interrupts is # microseconds .TP -\fI-B, --buffer-time=#\fP +\fI\-B, \-\-buffer\-time=#\fP Buffer duration is # microseconds .TP -\fI--period-size=#\fP +\fI\-\-period\-size=#\fP Distance between interrupts is # frames .TP -\fI--buffer-size=#\fP +\fI\-\-buffer\-size=#\fP Buffer duration is # frames .TP -\fI-A, --avail-min=#\fP +\fI\-A, \-\-avail\-min=#\fP Min available space for wakeup is # microseconds .TP -\fI-R, --start-delay=#\fP +\fI\-R, \-\-start\-delay=#\fP Delay for automatic PCM start is # microseconds (relative to buffer size if <= 0) .TP -\fI-T, --stop-delay=#\fP +\fI\-T, \-\-stop\-delay=#\fP Delay for automatic PCM stop is # microseconds from xrun .TP -\fI-v, --verbose\fP +\fI\-v, \-\-verbose\fP Show PCM structure and setup. This option is accumulative. The VU meter is displayed when this is given twice. .TP -\fI-I, --separate-channels\fP +\fI\-I, \-\-separate\-channels\fP One file for each channel .SS Example: .TP -\fBaplay -c 1 -t raw -r 22050 -f mu_law foobar\fR +\fBaplay \-c 1 \-t raw \-r 22050 \-f mu_law foobar\fR will play the raw file "foobar" as a 22050-Hz, mono, 8-bit, Mu-Law .au file. .TP -\fBarecord -d 10 -f cd -t wav -D copy foobar.wav\fP +\fBarecord \-d 10 \-f cd \-t wav \-D copy foobar.wav\fP will record foobar.wav as a 10-second, CD-quality wave file, using the PCM "copy" (which might be defined in the user's .asoundrc file as: .nf diff --git a/iecset/iecset.1 b/iecset/iecset.1 index c1280d3..fd47595 100644 --- a/iecset/iecset.1 +++ b/iecset/iecset.1 @@ -16,14 +16,14 @@ and the IEC958 status bits are updated. The resultant status is shown as well. The commands consist of the command directive and the argument. -As the boolean argument, \fIyes\fP, \fIno\fP, \fItrue\fP, \fIfalse\fI, +As the boolean argument, \fIyes\fP, \fIno\fP, \fItrue\fP, \fIfalse\fP, or a digit number is allowed. .SH EXAMPLES .TP .BI iecset\ \-Dhw:1 Displays the current IEC958 status bits on the second card. -This is equivalent with \fI-c 1\fP. +This is equivalent with \fI\-c 1\fP. .TP .BI iecset\ \-x Displays the current IEC958 status bits in a style of the arguments @@ -36,16 +36,16 @@ non-audio bit. The modified status will be shown, too. .SH OPTIONS .TP -\fI-D\fP device +\fI\-D\fP device Specifies the device name of the control to open .TP -\fI-c\fP card -Specifies the card index to open. Equivalent with \fI-Dhw:x\fP. +\fI\-c\fP card +Specifies the card index to open. Equivalent with \fI\-Dhw:x\fP. .TP -\fI-x\fP +\fI\-x\fP Dumps the status in the form of AESx bytes. .TP -\fI-i\fP +\fI\-i\fP Reads the command sequences from stdin. Each line has single command. diff --git a/seq/aconnect/aconnect.1 b/seq/aconnect/aconnect.1 index ceb64e9..219e417 100644 --- a/seq/aconnect/aconnect.1 +++ b/seq/aconnect/aconnect.1 @@ -5,10 +5,10 @@ aconnect \- ALSA sequencer connection manager .SH SYNOPSIS .B aconnect -[\-d] [-options] sender receiver +[\-d] [\-options] sender receiver .br .B aconnect -\-i|-o [-options] +\-i|\-o [\-options] .br .B aconnect \-x @@ -34,7 +34,7 @@ For disconnection, use .B \-d option. .IP "" 4 -% aconnect -d 64:0 65:0 +% aconnect \-d 64:0 65:0 .PP The address can be given using the client's name. .IP "" 4 @@ -53,7 +53,7 @@ ports, can be listed with .B \-i option. .IP "" 4 -% aconnect -i +% aconnect \-i .br client 0: 'System' [type=kernel] .in +4 @@ -61,9 +61,9 @@ client 0: 'System' [type=kernel] .br 1 'Announce ' .in -4 -client 64: 'External MIDI-0' [type=kernel] +client 64: 'External MIDI\-0' [type=kernel] .in +4 -0 'MIDI 0-0 ' +0 'MIDI 0\-0 ' .in -4 .PP Similary, to see the output ports, use @@ -79,23 +79,23 @@ unless their connections are removed. .SH OPTIONS .SS CONNNECTION MANAGEMENT .TP -.B \-d, --disconnect +.B \-d, \-\-disconnect Disconnect the given subscription. .TP -.B \-e, --exclusive +.B \-e, \-\-exclusive Connect ports with exclusive mode. Both sender and receiver ports can be no longer connected by any other ports. .TP -.B \-r, --real queue +.B \-r, \-\-real queue Convert time-stamps of event packets to the current value of the given .I real-time queue. This is option is, however, not so useful, since the receiver port must use (not necessarily own) the specified queue. .TP -.B \-t, --tick queue +.B \-t, \-\-tick queue Like -.B -r +.B \-r option, but time-stamps are converted to the current value of the given .I tick @@ -103,17 +103,17 @@ queue. .SS LIST PORTS .TP -.B \-i, --input +.B \-i, \-\-input List existing input (readable) ports. This option is exclusive to .B \-o. .TP -.B \-o, --output +.B \-o, \-\-output List existing output (writable) ports. This option is exclusive to .B \-i. .TP -.B \-l, --list +.B \-l, \-\-list List the current connection status. The connected and connecting ports from/to each port are listed together. The suffix flag @@ -128,7 +128,7 @@ queue, respectively. .SS REMOVE ALL CONNECTIONS .TP -.B \-x, --removeall +.B \-x, \-\-removeall Remove all exported connections. .SH "SEE ALSO" diff --git a/seq/aplaymidi/aplaymidi.1 b/seq/aplaymidi/aplaymidi.1 index f4c027c..0134129 100644 --- a/seq/aplaymidi/aplaymidi.1 +++ b/seq/aplaymidi/aplaymidi.1 @@ -5,7 +5,7 @@ aplaymidi \- play Standard MIDI Files .SH SYNOPSIS .B aplaymidi --p client:port[,...] [-d delay] midifile ... +\-p client:port[,...] [\-d delay] midifile ... .SH DESCRIPTION .B aplaymidi @@ -15,19 +15,19 @@ or more ALSA sequencer ports. .SH OPTIONS .TP -.I -h, --help +.I \-h, \-\-help Prints a list of options. .TP -.I -V, --version +.I \-V, \-\-version Prints the current version. .TP -.I -l, --list +.I \-l, \-\-list Prints a list of possible output ports. .TP -.I -p, --port=client:port,... +.I \-p, \-\-port=client:port,... Sets the sequencer port(s) to which the events in the MIDI file(s) are sent. @@ -42,7 +42,7 @@ the port specification is taken from the environment variable if none is given on the command line. .TP -.I -d, --delay=seconds +.I \-d, \-\-delay=seconds Specifies how long to wait after the end of each MIDI file, to allow the last notes to die away. diff --git a/seq/aplaymidi/arecordmidi.1 b/seq/aplaymidi/arecordmidi.1 index d1914a0..56a08d1 100644 --- a/seq/aplaymidi/arecordmidi.1 +++ b/seq/aplaymidi/arecordmidi.1 @@ -1,11 +1,11 @@ .TH ARECORDMIDI 1 "6 Apr 2004" .SH NAME -arecordmidi - record Standard MIDI Files +arecordmidi \- record Standard MIDI Files .SH SYNOPSIS .B arecordmidi --p client:port[,...] [options] midifile +\-p client:port[,...] [options] midifile .SH DESCRIPTION .B arecordmidi @@ -17,19 +17,19 @@ To stop recording, press Ctrl+C. .SH OPTIONS .TP -.I -h,--help +.I \-h,\-\-help Prints a list of options. .TP -.I -V,--version +.I \-V,\-\-version Prints the current version. .TP -.I -l,--list +.I \-l,\-\-list Prints a list of possible input ports. .TP -.I -p,--port=client:port,... +.I \-p,\-\-port=client:port,... Sets the sequencer port(s) from which events are recorded. A client can be specified by its number, its name, or a prefix of its @@ -37,40 +37,40 @@ name. A port is specified by its number; for port 0 of a client, the ":0" part of the port specification can be omitted. .TP -.I -b,--bpm=beats +.I \-b,\-\-bpm=beats Sets the musical tempo of the MIDI file, in beats per minute. The default value is 120 BPM. .TP -.I -f,--fps=frames +.I \-f,\-\-fps=frames Sets the SMPTE resolution, in frames per second. Possible values are 24, 25, 29.97 (for 30 drop-frame), and 30. .TP -.I -t,--ticks=ticks +.I \-t,\-\-ticks=ticks Sets the resolution of timestamps (ticks) in the MIDI file, in ticks per beat (when using musical tempo) or ticks per frame (when using SMPTE timing). The default value is 384 ticks/beat or 40 ticks/frame, respectively. .TP -.I -s,--split-channels +.I \-s,\-\-split\-channels Specifies that the data for each MIDI channel should be written to a separate track in the MIDI file. .TP -.I -d,--dump +.I \-d,\-\-dump Shows the events received as text on standard output. .TP -.I -m,--metronome=client:port +.I \-m,\-\-metronome=client:port Plays a metronome signal on the specified sequencer port. Metronome sounds are played on channel 10, MIDI notes 33 & 34 (GM2/GS/XG metronome standard notes), with velocity 100 and duration 1. .TP -.I -i,--timesig=numerator:denominator +.I \-i,\-\-timesig=numerator:denominator Sets the time signature for the MIDI file and metronome. The time signature is specified as usual with two numbers, representing diff --git a/seq/aseqnet/aseqnet.1 b/seq/aseqnet/aseqnet.1 index 2e8ac8e..a1dc1d3 100644 --- a/seq/aseqnet/aseqnet.1 +++ b/seq/aseqnet/aseqnet.1 @@ -49,7 +49,7 @@ Then events to hostA:128:0 will be delivered to hostB:65:0. The following command plays MIDI on .I hostB. .IP "" 4 -hostA% pmidi -p 128:0 foo.mid +hostA% pmidi \-p 128:0 foo.mid .PP The multiple clients may exist simultaneously. If .I hostC