diff options
Diffstat (limited to 'Build/source/texk/gregorio/gregorio-4.0.0-rc1/debian/manpage.xml')
-rw-r--r-- | Build/source/texk/gregorio/gregorio-4.0.0-rc1/debian/manpage.xml | 224 |
1 files changed, 224 insertions, 0 deletions
diff --git a/Build/source/texk/gregorio/gregorio-4.0.0-rc1/debian/manpage.xml b/Build/source/texk/gregorio/gregorio-4.0.0-rc1/debian/manpage.xml new file mode 100644 index 00000000000..59ff7e056eb --- /dev/null +++ b/Build/source/texk/gregorio/gregorio-4.0.0-rc1/debian/manpage.xml @@ -0,0 +1,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> |