]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/converters.itely
Rename macros to better indicate the output.
[lilypond.git] / Documentation / user / converters.itely
index 451e59f9ce3e5387ea4aefe3845ce11a083d4e3f..9b293bcaa9abd58b16618292f024bcad335504b7 100644 (file)
@@ -1,4 +1,11 @@
 @c -*- coding: utf-8; mode: texinfo; -*-
+@c This file is part of lilypond-program.tely
+@ignore
+    Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
+
+    When revising a translation, copy the HEAD committish of the
+    version that you are working on.  See TRANSLATION for details.
+@end ignore
 
 @node Converting from other formats
 @chapter Converting from other formats
@@ -10,27 +17,20 @@ sequencers and XML converters.  Refer to the
 @uref{http://@/lilypond@/.org,website} for more details.
 
 These are separate programs from lilypond itself, and are run
-on the command-line.  By ``command-line'', we mean the command
-line in the operating system.  Windows users
-might be more familiar with the terms ``DOS shell'' or
-``command shell''; OSX users might be more familiar with the
-terms ``terminal'' or ``console''.  OSX users should also
-consult @ref{Notes for the MacOS X app}.
-
-Describing how to use
-this part of an operating system is outside the scope of this
-manual; please consult other documentation on this topic if
-you are unfamiliar with the command-line.
+on the command-line; see @ref{Command-line usage} for more information.
 
 
+@knownissues
+We unfortunately do not have the resources to maintain these
+programs; please consider them @qq{as-is}.  Patches are appreciated, but
+bug reports will almost certainly not be resolved.
 
 @menu
 * Invoking midi2ly::            Importing MIDI.
-* Invoking etf2ly::             Importing Finale.
-* Invoking musicxml2ly::        
+* Invoking musicxml2ly::        Importing MusicXML.
 * Invoking abc2ly::             Importing ABC.      
-* Invoking mup2ly::             Importing MUP.
-* Generating LilyPond files::   
+* Invoking etf2ly::             Importing Finale.
+* Generating LilyPond files::   GUIs, transcribers, and algorithmic composition programs.
 @end menu
 
 
@@ -68,8 +68,8 @@ It is invoked from the command-line as follows,
 midi2ly [@var{option}]@dots{} @var{midi-file}
 @end example
 
-Note that by ``command-line'', we mean the command line of the
-operating system.  See @ref{Converting from other formats} for
+Note that by @q{command-line}, we mean the command line of the
+operating system.  See @ref{Converting from other formats}, for
 more information about this.
 
 The following options are supported by @command{midi2ly}.
@@ -90,7 +90,7 @@ Show summary of usage.
 @item -k, --key=@var{acc}[:@var{minor}]
 Set default key.  @math{@var{acc} > 0} sets number of sharps;
 @math{@var{acc} < 0} sets number of flats.  A minor key is indicated by
-":1".
+@code{:1}.
 
 @item -o, --output=@var{file}
 Write output to @var{file}.
@@ -115,52 +115,13 @@ Treat every text as a lyric.
 @end table
 
 
-@refbugs
+@knownissues
 
 Overlapping notes in an arpeggio will not be correctly rendered.  The
 first note will be read and the others will be ignored.  Set them all
 to a single duration and add phrase markings or pedal indicators.
 
 
-@node Invoking etf2ly
-@section Invoking @command{etf2ly}
-
-@cindex ETF
-@cindex enigma
-@cindex Finale
-@cindex Coda Technology
-
-ETF (Enigma Transport Format) is a format used by Coda Music
-Technology's Finale product.  @command{etf2ly} will convert part of an ETF
-file to a ready-to-use LilyPond file.
-
-It is invoked from the command-line as follows.
-
-@example
-etf2ly [@var{option}]@dots{} @var{etf-file}
-@end example
-
-Note that by ``command-line'', we mean the command line of the
-operating system.  See @ref{Converting from other formats} for
-more information about this.
-
-The following options are supported by @command{etf2ly}:
-
-@table @code
-@item -h,--help
-this help
-@item -o,--output=FILE
-set output filename to FILE
-@item -v,--version
-version information
-@end table
-
-
-@refbugs
-
-The list of articulation scripts is incomplete.  Empty measures
-confuse @command{etf2ly}.  Sequences of grace notes are ended improperly.
-
 @node Invoking musicxml2ly
 @section Invoking @code{musicxml2ly}
 
@@ -170,8 +131,8 @@ for representing music notation.
 @command{musicxml2ly} extracts the notes from part-wise MusicXML
 files, and writes it to a .ly file.  It is invoked from the command-line.
 
-Note that by ``command-line'', we mean the command line of the
-operating system.  See @ref{Converting from other formats} for
+Note that by @q{command-line}, we mean the command line of the
+operating system.  See @ref{Converting from other formats}, for
 more information about this.
 
 The following options are supported by @command{musicxml2ly}:
@@ -185,6 +146,7 @@ set output filename to @var{file}. (default: print to stdout)
 print version information.
 @end table
 
+
 @node Invoking abc2ly
 @section Invoking @code{abc2ly}
 
@@ -193,7 +155,7 @@ print version information.
 ABC is a fairly simple ASCII based format.  It is described at the ABC site:
 
 @quotation
-@uref{http://@/www@/.gre@/.ac@/.uk/@/~c.walshaw/@/abc2mtex/@/abc@/.txt}.
+@uref{http://@/www@/.walshaw@/.plus@/.com/@/abc/@/abc2mtex/@/abc@/.txt}.
 @end quotation
 
 @command{abc2ly} translates from ABC to LilyPond.  It is invoked as follows:
@@ -220,7 +182,7 @@ source file.  If you say:
 %%LY voices \set autoBeaming = ##f
 @end example
 
-This will cause the text following the keyword ``voices'' to be inserted
+This will cause the text following the keyword @q{voices} to be inserted
 into the current voice of the LilyPond output file.
 
 Similarly,
@@ -229,13 +191,13 @@ Similarly,
 %%LY slyrics more words
 @end example
 
-will cause the text following the ``slyrics'' keyword to be inserted
+will cause the text following the @q{slyrics} keyword to be inserted
 into the current line of lyrics.
 
 
-@refbugs
+@knownissues
 
-The ABC standard is not very ``standard''.  For extended features
+The ABC standard is not very @q{standard}.  For extended features
 (e.g., polyphonic music) different conventions exist.
 
 Multiple tunes in one file cannot be converted.
@@ -246,45 +208,44 @@ ABC synchronizes words and notes at the beginning of a line;
 @command{abc2ly} ignores the ABC beaming.
 
 
-@node Invoking mup2ly
-@section Invoking @command{mup2ly}
+@node Invoking etf2ly
+@section Invoking @command{etf2ly}
 
-Mup (Music Publisher) is a shareware music notation program by Arkkra
-Enterprises.  @command{mup2ly} will convert part of a Mup file to LilyPond
-format.  It is invoked from the command-line as follows:
+@cindex ETF
+@cindex enigma
+@cindex Finale
+@cindex Coda Technology
 
-@cindex Music Publisher
-@cindex Mup
-@cindex Arkkra
+ETF (Enigma Transport Format) is a format used by Coda Music
+Technology's Finale product.  @command{etf2ly} will convert part of an ETF
+file to a ready-to-use LilyPond file.
+
+It is invoked from the command-line as follows.
 
 @example
-mup2ly [@var{option}]@dots{} @var{mup-file}
+etf2ly [@var{option}]@dots{} @var{etf-file}
 @end example
 
-The following options are supported by @command{mup2ly}:
+Note that by @q{command-line}, we mean the command line of the
+operating system.  See @ref{Converting from other formats}, for
+more information about this.
+
+The following options are supported by @command{etf2ly}:
 
 @table @code
-@item -d,--debug
-show what constructs are not converted, but skipped.
-@item -D, --define=@var{name}[=@code{exp}]
-define macro @var{name} with opt expansion @code{exp}
-@item -E,--pre-process
-only run the pre-processor
 @item -h,--help
-print help
-@item -o,--output=@var{file}
-write output to @var{file}
+this help
+@item -o,--output=FILE
+set output filename to FILE
 @item -v,--version
 version information
-@item -w,--warranty
-print warranty and copyright.
 @end table
 
 
-@refbugs
+@knownissues
 
-Only plain notes (pitches, durations), voices, and staves are
-converted.
+The list of articulation scripts is incomplete.  Empty measures
+confuse @command{etf2ly}.  Sequences of grace notes are ended improperly.
 
 
 @node Generating LilyPond files
@@ -297,7 +258,7 @@ there are some external tools that also generate LilyPond files.
 
 These tools include
 
-@itemize @bullet
+@itemize
 @item
 @uref{http://@/denemo@/.sourceforge@/.net/,Denemo}, a graphical score editor.
 @item
@@ -315,5 +276,8 @@ which imports @uref{http://@/www@/.musicxml@/.com/xml@/.html,MusicXML}
 @item
 @uref{http://@/www@/.rosegardenmusic@/.com,Rosegarden},
 which imports MIDI
+@item
+@uref{http://@/common-lisp@/.net/project/fomus/,FOMUS},
+a LISP library to generate music notation 
 @end itemize