Added "whitespace" to man pages.

This commit is contained in:
Svend Sorensen
2005-02-02 00:13:40 +00:00
parent cd600928a5
commit f1e33641a2
3 changed files with 65 additions and 0 deletions

View File

@@ -1,23 +1,31 @@
.TH cuetools 1 .TH cuetools 1
.
.SH NAME .SH NAME
cuebreakpoints cuebreakpoints
.
.SH DESCRIPTION .SH DESCRIPTION
cuebreakpoints \- print the breakpoints from a cue or toc file cuebreakpoints \- print the breakpoints from a cue or toc file
.
.SH SYNTAX .SH SYNTAX
cuebreakpoints [\-h] [\-i cue|toc] [file...] cuebreakpoints [\-h] [\-i cue|toc] [file...]
.
.SH OPTIONS .SH OPTIONS
.TP .TP
.B \-h .B \-h
print usage information print usage information
.
.TP .TP
.B \-i cue|toc .B \-i cue|toc
set format of file(s) set format of file(s)
.
.SH NOTES .SH NOTES
The breakpoints are in a format usable by shnsplit (part of the shntool package). A track breakpoint is at index 1. The breakpoints are in a format usable by shnsplit (part of the shntool package). A track breakpoint is at index 1.
.PP .PP
If no files are specified, stdin is used. If a filename is specified and the format is not specified, the format will be set based on a ".cue" or ".toc" suffix. If no files are specified, stdin is used. If a filename is specified and the format is not specified, the format will be set based on a ".cue" or ".toc" suffix.
.
.SH AUTHOR .SH AUTHOR
Svend Sorensen Svend Sorensen
.
.SH "SEE ALSO" .SH "SEE ALSO"
cueconvert(1), cueconvert(1),
cueprint(1) cueprint(1)

View File

@@ -1,24 +1,33 @@
.TH cuetools 1 .TH cuetools 1
.
.SH NAME .SH NAME
cueconvert cueconvert
.
.SH DESCRIPTION .SH DESCRIPTION
cueconvert \- convert between the cue and toc formats cueconvert \- convert between the cue and toc formats
.
.SH SYNTAX .SH SYNTAX
cueconvert [\-h] [\-i cue|toc] [\-o cue|toc] [infile [outfile]] cueconvert [\-h] [\-i cue|toc] [\-o cue|toc] [infile [outfile]]
.
.SH OPTIONS .SH OPTIONS
.TP .TP
.B \-h .B \-h
print usage information print usage information
.
.TP .TP
.B \-i cue|toc .B \-i cue|toc
set format of input file set format of input file
.
.TP .TP
.B \-o cue|toc .B \-o cue|toc
set format of output file set format of output file
.
.SH NOTES .SH NOTES
If infile or outfile is not specified, stdin and stdout are used, respectively. If a filename is specified and the format is not specified, the format will be set based on a ".cue" or ".toc" suffix. If the output file format is not specified, and it cannot be determined from the suffix, it will be set to the opposite of the input format. If infile or outfile is not specified, stdin and stdout are used, respectively. If a filename is specified and the format is not specified, the format will be set based on a ".cue" or ".toc" suffix. If the output file format is not specified, and it cannot be determined from the suffix, it will be set to the opposite of the input format.
.
.SH AUTHOR .SH AUTHOR
Svend Sorensen Svend Sorensen
.
.SH "SEE ALSO" .SH "SEE ALSO"
cuebreakpoints(1), cuebreakpoints(1),
cueprint(1) cueprint(1)

View File

@@ -1,139 +1,185 @@
.TH cuetools 1 .TH cuetools 1
.
.SH NAME .SH NAME
cueprint cueprint
.
.SH DESCRIPTION .SH DESCRIPTION
cueprint \- print disc and track infomation for a cue or toc file cueprint \- print disc and track infomation for a cue or toc file
.
.SH SYNTAX .SH SYNTAX
cueprint [\-h] [\-i cue|toc] [-n <tracknumber>] [\-d <template>] [\-t <template>] [file...] cueprint [\-h] [\-i cue|toc] [-n <tracknumber>] [\-d <template>] [\-t <template>] [file...]
.
.SH OPTIONS .SH OPTIONS
.TP .TP
.B \-h .B \-h
print usage information print usage information
.
.TP .TP
.B \-i cue|toc .B \-i cue|toc
set format of file(s) set format of file(s)
.
.TP .TP
.B \-n <tracknumber> .B \-n <tracknumber>
only print track information for track tracknumber. The default is to print information for all tracks. only print track information for track tracknumber. The default is to print information for all tracks.
.
.TP .TP
.B \-d <template> .B \-d <template>
set disc template (see TEMPLATE EXPANSION) set disc template (see TEMPLATE EXPANSION)
.
.TP .TP
.B \-t <template> .B \-t <template>
set track template (see TEMPLATE EXPANSION) set track template (see TEMPLATE EXPANSION)
.
.SH TEMPLATE EXPANSION .SH TEMPLATE EXPANSION
All characters in the template are reproduced in the output except for conversions, which begin with `%'. All characters in the template are reproduced in the output except for conversions, which begin with `%'.
.PP .PP
A conversion has the form `%[flags][width][.precision]<conversion\-char>'. A conversion has the form `%[flags][width][.precision]<conversion\-char>'.
.PP .PP
There may be zero or more of the following flags: There may be zero or more of the following flags:
.
.TP .TP
.B \- .B \-
left justification left justification
.
.TP .TP
.B + .B +
place sign before numbers place sign before numbers
.
.TP .TP
.B ` ' .B ` '
(space) place a space before a positive number (space) place a space before a positive number
.
.TP .TP
.B 0 .B 0
pad with zeros pad with zeros
.
.TP .TP
.B # .B #
(unused) (unused)
.
.PP .PP
width is the minimum field width. precision is the maximum width for strings. width is the minimum field width. precision is the maximum width for strings.
.PP .PP
Disc template expansion characters are valid for both the disc and track templates. Disc template expansion characters are valid for both the disc and track templates.
.PP .PP
.B Disc Conversion Specifiers .B Disc Conversion Specifiers
.
.TP .TP
.B A .B A
album arranger album arranger
.
.TP .TP
.B C .B C
album composer album composer
.
.TP .TP
.B G .B G
album genre album genre
.
.TP .TP
.B M .B M
album message album message
.
.TP .TP
.B N .B N
number of tracks number of tracks
.
.TP .TP
.B P .B P
album performer album performer
.
.TP .TP
.B S .B S
album songwriter album songwriter
.
.TP .TP
.B T .B T
album title album title
.
.TP .TP
.B U .B U
album UPC/EAN album UPC/EAN
.
.PP .PP
.B Track Conversion Specifiers .B Track Conversion Specifiers
.
.TP .TP
.B a .B a
track arranger track arranger
.
.TP .TP
.B c .B c
track composer track composer
.
.TP .TP
.B g .B g
track genre track genre
.
.TP .TP
.B i .B i
track ISRC track ISRC
.
.TP .TP
.B m .B m
track message track message
.
.TP .TP
.B n .B n
track number track number
.
.TP .TP
.B p .B p
track perfomer track perfomer
.
.TP .TP
.B t .B t
track title track title
.
.TP .TP
.B u .B u
track ISRC (CD-TEXT) track ISRC (CD-TEXT)
.
.PP .PP
Any other character is expanded to that character. For example, a % expands to a literal `%'. Any other character is expanded to that character. For example, a % expands to a literal `%'.
.
.SH ESCAPES .SH ESCAPES
The following single-character escapes are recognized: The following single-character escapes are recognized:
.
.TP .TP
.B \ea .B \ea
alert (bell) alert (bell)
.
.TP .TP
.B \eb .B \eb
backspace backspace
.
.TP .TP
.B \ef .B \ef
formfeed formfeed
.
.TP .TP
.B \en .B \en
newline newline
.
.TP .TP
.B \er .B \er
carriage return carriage return
.
.TP .TP
.B \et .B \et
horizontal tab horizontal tab
.
.TP .TP
.B \ev .B \ev
vertial tab vertial tab
.
.TP .TP
.B \e0 .B \e0
NULL NULL
.
.SH NOTES .SH NOTES
If no files are specified, stdin is used. If a filename is specified and the format is not specified, the format will be set based on a ".cue" or ".toc" suffix. If no files are specified, stdin is used. If a filename is specified and the format is not specified, the format will be set based on a ".cue" or ".toc" suffix.
.
.SH EXAMPLES .SH EXAMPLES
To display disc and track information (using the default template for both), run: To display disc and track information (using the default template for both), run:
.PP .PP
@@ -142,8 +188,10 @@ To display disc and track information (using the default template for both), run
To print the number of tracks in a cue file, run: To print the number of tracks in a cue file, run:
.PP .PP
% cueprint -d '%N\en' album.cue % cueprint -d '%N\en' album.cue
.
.SH AUTHOR .SH AUTHOR
Svend Sorensen Svend Sorensen
.
.SH "SEE ALSO" .SH "SEE ALSO"
cueconvert(1), cueconvert(1),
cuebreakpoints(1) cuebreakpoints(1)