You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

196 lines
4.6 KiB

  1. .TH "cueprint" "1"
  2. .SH NAME
  3. cueprint \- report disc and track information from a CUE or TOC file
  4. .SH SYNOPSIS
  5. .B cueprint
  6. [ {
  7. .B \-i
  8. .I format
  9. |
  10. .BR \-\-input\-format =\fIformat\fP
  11. } {
  12. .B \-n
  13. .I number
  14. |
  15. .BR \-\-track\-number =\fInumber\fP
  16. } {
  17. .B \-d
  18. .I template
  19. |
  20. .BR \-\-disc\-template =\fItemplate\fP
  21. } {
  22. .B \-t
  23. .I template
  24. |
  25. .BR \-\-track\-template =\fItemplate\fP
  26. } ]
  27. [
  28. .I file
  29. \&... ]
  30. .br
  31. .B cueprint \-h | \-\-help
  32. .br
  33. .B cueprint \-V | \-\-version
  34. .SH DESCRIPTION
  35. .B cueprint
  36. reports disc and track information from CUE and TOC files, which are
  37. typically created by compact disc ripping software.
  38. .PP
  39. By default,
  40. .B cueprint
  41. reports a default set of disc information, and a default set of information
  42. for each track on the disc.
  43. With options, the report can be restricted to a specific track, and the
  44. presentation of the disc and track information can be extensively
  45. customized using
  46. .BR printf (3)-style
  47. format strings (referred to here as \(oqtemplates\(cq to avoid confusion
  48. with the concept of file format).
  49. All characters in a template are reproduced as-is in the output except for
  50. conversions (which begin with
  51. .RB \(oq % \(cq)
  52. and escapes (which begin with
  53. .RB \(oq \e \(cq).
  54. .PP
  55. If no filenames are specified,
  56. .B cueprint
  57. reads from standard input, and an input format option
  58. .I must
  59. be specified.
  60. If one or more filenames is provided, but the input format option is not
  61. specified, the input format will be guessed based on each file's suffix
  62. (e.g.,
  63. .I .cue
  64. or
  65. .IR .toc ).
  66. This heuristic is case-insensitive.
  67. .SS Conversions
  68. A conversion has the form
  69. .RB \(oq % [ \fIflags\fP ][ \fIwidth\fP ][ .\fIprecision\fP ] \fItype\fP \(cq.
  70. .PP
  71. .I flags
  72. may be zero or more of the following:
  73. .TS
  74. nokeep;
  75. l l.
  76. Character Meaning
  77. _
  78. \- left-justify expansion
  79. + place sign before numbers
  80. \(oq \(cq (space) place a blank space before a positive number
  81. 0 pad numbers with zeroes
  82. .TE
  83. .\"# (unused)
  84. .PP
  85. .I width
  86. is the minimum field width.
  87. .I precision
  88. is the maximum width for strings.
  89. .I type
  90. is a single character which specifies the conversion type \(em apart from
  91. .BR % ,
  92. it is the only mandatory part of the conversion.
  93. .PP
  94. The available conversion types are presented in the table below; disc
  95. conversion types are presented in the left half of the table, and track
  96. conversion types in the right half.
  97. Disc template expansion characters are valid for both disc and track
  98. templates.
  99. .TS
  100. nokeep;
  101. l l l l.
  102. Character Conversion Character Conversion
  103. _
  104. A album arranger a track arranger
  105. C album composer c track composer
  106. G album genre g track genre
  107. i track ISRC
  108. M album message m track message
  109. N number of tracks n track number
  110. P album performer p track performer
  111. S album songwriter
  112. T album title t track title
  113. U album UPC/EAN u track ISRC (CD-TEXT)
  114. .TE
  115. .PP
  116. Any other character used as a conversion type expands to itself.
  117. This is how a literal percent sign is placed in the template; i.e.,
  118. .RB \(oq %% \(cq
  119. expands to
  120. .RB \(oq % \(cq.
  121. .SS Escapes
  122. The recognized escapes are all single characters, and listed in the table
  123. below.
  124. .TS
  125. nokeep;
  126. l l.
  127. Escape Sequence Expansion
  128. _
  129. \ea alert (bell)
  130. \eb backspace
  131. \ef formfeed
  132. \en newline
  133. \er carriage return
  134. \et horizontal tab
  135. \ev vertical tab
  136. \e0 null
  137. .TE
  138. .PP
  139. Any other character used after the
  140. .RB \(oq \e \(cq
  141. in an escape sequence expands to itself.
  142. This is how a literal escape character is placed in the template; i.e.,
  143. .RB \(oq \e\e \(cq
  144. expands to
  145. .RB \(oq \e \(cq.
  146. .SH OPTIONS
  147. .TP
  148. .BR \-d " \fItemplate\fP, " \-\-disc\-template=\fItemplate\fP
  149. set disc template (see
  150. .B Conversions
  151. )
  152. .TP
  153. .BR \-h ", " \-\-help
  154. displays a usage message and exits.
  155. .TP
  156. .BR \-i " \fIformat\fP, " \-\-input\-format=\fIformat\fP
  157. sets the expected format of the input file(s) to
  158. .IR format ,
  159. which must be either
  160. .B cue
  161. or
  162. .BR toc .
  163. .TP
  164. .BR \-n " \fInumber\fP, " \-\-track\-number=\fInumber\fP
  165. only print track information for a single track.
  166. The default is to print information for all tracks.
  167. .TP
  168. .BR \-t " \fItemplate\fP, " \-\-track\-template=\fItemplate\fP
  169. set track template (see
  170. .B Conversions
  171. )
  172. .TP
  173. .B \-V ", " \-\-version
  174. displays version information and exits.
  175. .SH "EXIT STATUS"
  176. .B cueprint
  177. exits with status zero if it successfully reports information from each
  178. input file, and nonzero if there were problems.
  179. .SH EXAMPLES
  180. To display disc and track information (using the default template for
  181. both):
  182. .PP
  183. .RB "% " "cueprint album.cue"
  184. .PP
  185. To print the number of tracks in a CUE file:
  186. .PP
  187. .RB "% " "cueprint -d \(aq%N\en\(aq album.cue"
  188. .SH AUTHOR
  189. Cuetools was written by Svend Sorensen.
  190. Branden Robinson contributed fixes and enhancements to the utilities and
  191. documentation.
  192. .SH "SEE ALSO"
  193. .BR cuebreakpoints (1),
  194. .BR cueconvert (1),
  195. .BR printf(3)