Debian Codegraph @

upstream/debian-unstable/man1/yaps.1

raw
1 .TH YAPS 1 "13 August 2005"
2 .SH NAME
3 .B
4 YAPS
5 \- converts an abc file to a PostScript file
6 .SH SYNOPSIS
7 yaps \fiabc\ file\fP [\-d] [\-e\ <list>] [\-E] [\-l] [\-M \fiXXXxYYY\fP] \
8 [\-N] [\-k nn] [\-o \fifile\ name\fP] [\-P \-\fiss\fP] [\-s \fiXX\fP] [\-V]\
9 [\-ver] [\-x] [\-OCC]
10
11
12
13 .SH OPTIONS
14 .TP
15 .B -d
16 For debugging only. Displays the internal data structures used in the program.
17 .TP
18 .B -e \fi<list>\fP
19 Draws tunes with reference numbers in a comma separated list. Spaces are
20 not allowed but a range of reference numbers can be specified. For example,
21 1,3,7-10.
22 .TP
23 .B -E
24 Generates Encapsulated Postscript output.
25 .TP
26 .B -M \fiXXXxYYY\fb
27 Set margin sizes in points where 28.3 points = 1cm and 72 points = 1 inch.
28 .TP
29 .B -N
30 Adds page numbering.
31 .TP
32 .B -k [nn]
33 Adds bar numbering. If number nn is included, then every nn'th bar
34 is numbered. Otherwise all bars are numbered.
35 .TP
36 .B -o \fifilename\fP
37 Specifies the output postscript file name.
38 .TP
39 .B -P \fiss\fP
40 Specifies the paper size where 0 is A4 and 1 is US Letter
41 or XXXxYYY sets the paper size in point units.
42 units.
43 .TP
44 .B -s \fiXX\fP
45 Specifies the scaling factor (default is 0.7)
46 .TP
47 .B -V
48 Voices are printed out separately for a multi-voice tune. Otherwise they
49 are interleaved.
50
51 .TP
52 .B -ver
53 Prints version number and exits.
54 .TP
55 .B -x
56 Print tune number in X: field
57 .TP
58 .B -OCC
59 Required if the tune uses the old convention for chords delineated
60 with +..+ instead of [...].
61
62 .SH FEATURES
63
64 .PP
65 * Uses the abc2midi parsing code, so hopefully compatibility with
66 abc2midi will be good.
67 .PP
68 * Measures the width of lyric text for lyric typesetting.
69 .PP
70 * Uses dynamically extensible data structures in most places, so
71 you should not be restricted by compiled-in limits.
72 .PP
73 * Multiple voices drawn with notes played at the same time aligned.
74 .PP
75 * Supports special characters using ISO latin 1 font. Special
76 characters are created with a TeX-like code e.g. \'E or a 3 digit octal
77 code e.g. \315 .
78 .PP
79 * Supports the following clefs : baritone, tenor, alto, mezzo, soprano,
80 treble, bass. Recommended use is
81 .PP
82 * Invisible rests (x) are displayed like normal rests.
83 .PP
84 * Nonnumeric voice id's, eg. V: soprano are accepted.
85 .PP
86 I:clef=bass
87 .PP
88 To make it easier to enter tunes in clefs othan than treble clef,
89 yaps supports I:octave=-1 to indicate that a C in the tune represents
90 the note one octave below the pitch defined in the abc standard. These
91 may be combined in one I: statement e.g.
92 .PP
93 I:clef=bass octave=-2
94 .PP
95 You can also use clefs that are one, two or three octaves higher or
96 lower than normal using e.g. treble-8, treble+15, treble-22. The clef is
97 drawn with a small 8, 15 or 22 above or below the clef symbol. The clef=
98 and octave= commands may also go in the K: field e.g.
99 .PP
100 K:G clef=bass-8 octave=-3
101 .PP
102 Note that there is an incompatibility between the behaviour of yaps and
103 the behaviour of abc2ps 1.3.3. abc2ps 1.3.3 does not support the
104 I:octave=N command, but selecting certain clefs causes it to automatically
105 transpose by several octaves. You can produce abc that works for both by
106 following the clef change with an I:octave=N command to do the transpose
107 that abc2ps does automatically.
108 .PP
109 * Produces boxed part labels.
110 .PP
111 * Supports the segno symbol with !segno! and coda with !coda! . Other
112 musical instructions such as !fine! and !D.C.! come out as text.
113 * Supports the U: field for abbreviating symbols to single characters. e.g.
114 .PP
115 U:S = !segno!
116 .PP
117 allows S to be used to produce the segno symbol. Currently this only
118 allows new symbols to be defined and does not allow the existing
119 pre-defined symbols M,L,R,H and T to be altered.
120 .PP
121 * Supports the !red! and !black! instructions for switching from
122 black to red or vice-versa.
123 .PP
124 * Supports the following abc2ps extensions to abc :
125 .PP
126 %%newpage - start a new page,
127 .br
128 %%vskip N - adds vertical space of N points. If N is followed by
129 'cm' or 'in' the units are taken as centimetres or
130 inches instead of points e.g. 4cm.
131 .br
132 %%text - print text
133 .br
134 %%centre (or %%center for Americans) - print centred text.
135 .br
136 If %%text or %%centre appear in the header, the text appears above
137 the tune.
138 .PP
139 %%staffsep SIZE - set the vertical blank space between 2 consecutive
140 music staves.
141 .PP
142 %%titleleft N - select title placed to the left or centred. N = 1
143 places the title on the left while N = 0 centres it.
144 .br
145 %%titlecaps - title is displayed in upper case (capital) letters.
146 .br
147 %%textfont NAME SIZE - select font called NAME and point size SIZE
148 for text produced by %%text or %%centre. If only NAME is given, the
149 font stays the same size. Likewise, if '-' is given as the NAME,
150 only the font size changes.
151 .br
152 %%titlefont NAME SIZE - select font for title.
153 .br
154 %%subtitlefont NAME SIZE - select font for titles after the first
155 title.
156 .br
157 %%composerfont NAME SIZE - select font for words in C: and O: fields
158 and part specifier (P: in header).
159 .br
160 %%wordsfont NAME SIZE - select font for words in W: fields.
161 .br
162 %%partsfont NAME SIZE - select font for boxed parts and
163 !instruction! .
164 .br
165 %%vocalfont NAME SIZE - select font for words in w: fields.
166 .br
167 %%gchordfont NAME SIZE - select font for guitar chords in the music.
168 (It is advisable not to change the font name for the last two, since
169 the program calculates the width of strings using default fonts)
170 .br
171 %%titlespace, %%subtitlespace, %%textspace, %%composerspace,
172 %%wordsspace, %%partsspace, %%vocalspace and %%gchordspace
173 determine the amount of space left above the relevant type
174 of text. Each of these should be followed by a size in points
175 or value in centrimetres or inches.
176 .br
177 e.g. %%composerfont 3
178 %%titlefont 2cm
179 .PP
180 * Supports placing of accompaniment chords either above or below the
181 stave.
182 .PP
183 %%chordsabove - places accompaniment chords above the stave
184 (default).
185 .br
186 %%chordsbelow - places accompaniment chords below the stave.
187 .PP
188 * Supports optional text enclosed in quotes before and after the
189 tempo specification in the Q: field. This extension comes from
190 abc2ps.
191
192 .SH AUTHOR
193 James Allwright <[email protected]>
194 .SH SUPPORTED
195 Seymour Shlien <[email protected]>
196 .PP
197 More complete documentation can be found in abcguide.txt which
198 comes with the abcMIDI distribution package.
199 .SH VERSION
200 This man page describes version 1.39 August 13 2005.
201