summaryrefslogtreecommitdiff
path: root/Build/source/texk/gregorio/gregorio-4.0.0-rc1/debian/manpage.xml
blob: 59ff7e056eb592cdb04ebb371e8ef030c22654aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!--

Process this file with an XSLT processor: `xsltproc \
-''-nonet /usr/share/xml/docbook/stylesheet/nwalsh/\
manpages/docbook.xsl manpage.xml'.  A manual page
<package>.<section> will be generated.  You may view the
manual page with: nroff -man <package>.<section> | less'.  A
typical entry in a Makefile or Makefile.am is:

DB2MAN=/usr/share/xml/docbook/stylesheet/nwalsh/manpages/\
docbook.xsl
XP=xsltproc -''-nonet

manpage.1: manpage.xml
        $(XP) $(DB2MAN) $<
    
The xsltproc binary is found in the xsltproc package.  The
XSL files are in docbook-xsl.  Please remember that if you
create the nroff version in one of the debian/rules file
targets (such as build), you will need to include xsltproc
and docbook-xsl in your Build-Depends control field.

-->

  <!ENTITY dhfirstname "<firstname>Elie</firstname>">
  <!ENTITY dhsurname   "<surname>Roux</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>juin  4, 2007</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>elie.roux@enst-bretagne.fr</email>">
  <!ENTITY dhusername  "Elie Roux">
  <!ENTITY dhucpackage "<refentrytitle>GREGORIO</refentrytitle>">
  <!ENTITY dhpackage   "gregorio">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2007</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>tool for gregorian chant typesetting</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>-hvVWsSL</option></arg>

      <arg><option>-o <replaceable>file</replaceable></option></arg>

      <arg><option>-f <replaceable>format</replaceable></option></arg>

      <arg><option>-F <replaceable>format</replaceable></option></arg>

      <arg><option>-l <replaceable>error-file</replaceable></option></arg>

      <arg><option><replaceable>file</replaceable></option></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para><command>&dhpackage;</command> is the software of the gregorio project, that comes with a lot of functionalities. The goal is to describe and typeset a gregorian chant score very simply. The <command>&dhpackage;</command> command is there to read and write the formats handled by the Gregorio project. See FORMATS for details.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>These programs follow the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</para>

    <variablelist>
      <varlistentry>
        <term><option>-h</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-V</option>
        </term>
        <listitem>
          <para>Show version of program.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-L</option>
        </term>
        <listitem>
          <para>Show licence of program.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>
        </term>
        <listitem>
          <para>Set the program in verbose mode.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-W</option>
        </term>
        <listitem>
          <para>Show all warnings.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option>
        </term>
        <listitem>
          <para>Read stdin as input.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-S</option>
        </term>
        <listitem>
          <para>Write output to stdout.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-F </option><replaceable>format</replaceable>
        </term>
        <listitem>
          <para>Sets the format of the produced file, where format is one of gabc, xml, otex, gtex, dump. See FORMATS for details. Default is gtex.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-f </option><replaceable>format</replaceable>
        </term>
        <listitem>
          <para>Sets the format of the file to read, where format is one of gabc, xml. See FORMATS for details. Default it gabc.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>FORMATS</title>
    <variablelist>
      <varlistentry>
        <term><option>gabc</option></term>
        <listitem>
          <para>Gregorian abc. The most interesting part of the Gregorio project, it is a very simple language made to describe briefly and simply a gregorian chant score. The syntax is quite close to abc language.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>xml</option></term>
        <listitem>
          <para>GregorioXML is a XML language describing a gregorian chant score.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>gtex</option></term>
        <listitem>
          <para>GregorioTeX is the TeX style made by the Gregorio project. You must install the <command>gregoriotex</command> environment to use it (it usually comes with gregorio).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>otex</option></term>
        <listitem>
          <para>OpusTeX is the most used TeX style to typeset a gregorian chant score. Install the <command>opustex</command> environment to use it.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>dump</option></term>
        <listitem>
          <para>This output simply dumps the internal <command>gregorio</command> structure. Only for debugging.</para>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>
  <refsect1>
    <title>EXAMPLE</title>
        <variablelist>
      <varlistentry>
        <term><command>gregorio myfile.gabc</command></term>
        <listitem>
          <para>converts the gabc file into GregorioTeX, and writes the result to <command>myfile.tex</command>.</para>
        </listitem>
      </varlistentry>
    </variablelist>
    </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para>http://home.gna.org/gregorio for a complete description of the formats.</para>

  </refsect1>
</refentry>