1.2 Uso da linea di comando

Questa sezione contiene informazioni aggiuntive sull’uso di LilyPond da linea di comando. Questo può essere utile per assegnare opzioni aggiuntive al programma. Inoltre, ci sono alcuni programmi complementari di ‘aiuto’ (come midi2ly) che funzionano solo da linea di comando.

Con ‘linea di comando’ si intende la linea di comando del sistema operativo. Gli utenti Windows avranno più familiarità con i termini ‘shell DOS’ o ‘shell dei comandi’. Gli utenti MacOS X avranno più familiarità con i termini ‘terminale’ o ‘console’. Una configurazione ulteriore è necessaria per gli utenti MacOS X; si veda MacOS X.

Descrivere come usare questa parte di un sistema operativo non rientra negli obiettivi di questo manuale; si prega di consultare altra documentazione su questo argomento se non si conosce la linea di comando.


Utilizzo di lilypond

L’eseguibile lilypond può essere lanciato dalla linea di comando nel seguente modo.

lilypond [opzione]… file

Se invocato con un nome di file senza estensione, viene tentata per prima l’estensione ‘.ly’. Per leggere l’input da stdin, usare un trattino (-) al posto di file.

Quando ‘file.ly’ viene elaborato, lilypond creerà ‘file.ps’ e ‘file.pdf’ come output. Possono essere specificati molti file; ognuno di essi sarà elaborato in modo indipendente. 1

Se ‘file.ly’ contiene più di un blocco \book, allora tutte le altre partiture verranno salvate in file numerati, a partire da ‘file-1.pdf’. Inoltre, il valore di output-suffix (suffisso di output) sarà inserito tra la base del nome del file e il numero. Un file di input che contiene

#(define output-suffix "violin")
\score { … }
#(define output-suffix "cello")
\score { … }

produrrà come output base-violin.pdf’ e base-cello-1.pdf’.


Comandi standard da shell

Se la shell (ovvero la finestra dei comandi) utilizzata supporta le normali redirezioni, potrebbe essere utile usare i seguenti comandi per dirigere l’output di una console in un file:

Consulta la documentazione della tua shell per vedere se supporta queste opzioni o se la sintassi è diversa. Nota che questi sono comandi shell e non hanno niente a che fare con lilypond.


Opzioni di base della linea di comando per LilyPond

Sono contemplate le seguenti opzioni:

-d, --define-default=variabile=valore

Si veda Opzioni avanzate della linea di comando per lilypond.

-e, --evaluate=espressione

Valuta l’espressione di Scheme prima di analizzare qualsiasi file ‘.ly’. Si possono specificare varie opzioni ‘-e’; saranno analizzate in modo sequenziale.

L’espressione sarà analizzata nel modulo guile-user, dunque se vuoi usare delle definizioni in espressione, usa

lilypond -e '(define-public a 42)'

nella linea di comando, e includi

#(use-modules (guile-user))

in cima al file .ly.

Nota: Gli utenti Windows devono usare i doppi apici invece dei singoli apici.

-f, --format=formato

Formati di output. Come formato si può scegliere tra ps, pdf e png.

Esempio: lilypond -fpng file.ly

-h, --help

Mostra una sintesi dell’utilizzo.

-H, --header=CAMPO

Estrae un campo dell’intestazione nel file ‘NOME.CAMPO’.

-i, --init=file

Imposta il file di inizializzazione su file (predefinito: ‘init.ly’).

-I, --include=directory

Aggiunge directory al percorso di ricerca per i file di input.

È possibile assegnare più opzioni -I. La ricerca inizierà nella prima directory definita, e se il file da includere non viene trovato la ricerca continuerà nelle directory seguenti.

-j, --jail=utente,gruppo,gabbia,directory

Esegue lilypond in una gabbia chroot.

L’opzione ‘--jail’ fornisce un’alternativa più flessibile a ‘--safe’ quando la formattazione di LilyPond è messa a disposizione attraverso un server web o quando LilyPond esegue sorgenti provenienti dall’esterno (si veda Opzioni avanzate della linea di comando per lilypond).

L’opzione ‘--jail’ modifica la radice di lilypond in gabbia appena prima di iniziare il vero processo di compilazione. L’utente e il gruppo vengono poi modificati per corrispondere a quelli forniti, e la directory corrente viene spostata in directory. Questa configurazione garantisce che non sia possibile (almeno in teoria) uscire dalla gabbia. Si noti che perché ‘--jail’ funzioni lilypond deve essere eseguito come root; di solito questo si fa in modo sicuro col comando sudo.

Configurare una gabbia è una questione un po’ delicata, perché bisogna essere sicuri che LilyPond possa trovare tutto quello di cui ha bisogno per compilare il sorgente dentro la gabbia. Una configurazione tipica comprende i seguenti elementi:

Impostare un filesystem distinto

Si dovrebbe creare un filesystem separato LilyPond, così che possa essere montato con opzioni di sicurezza come noexec, nodev, e nosuid. In questo modo è impossibile lanciare degli eseguibili o scrivere su un dispositivo direttamente da LilyPond. Se non si vuole creare una partizione separata, si può creare un file di dimensioni ragionevoli e usarlo per montare un dispositivo di loop. Un filesystem separato garantisce inoltre che LilyPond non possa scrivere su uno spazio maggiore di quanto permesso.

Impostare un altro utente

Per eseguire LilyPond in una gabbia si dovrebbe usare un altro utente e gruppo (ad esempio, lily/lily) con pochi privilegi. Ci dovrebbe essere una sola directory scrivibile da questo utente, che dovrebbe essere passata in dir.

Preparare la gabbia

LilyPond ha bisogno di leggere alcuni file quando viene lanciato. Tutti questi file devono essere copiati nella gabbia, sotto lo stesso percorso in cui appaiono nel vero filesystem principale. Si deve copiare l’intero contenuto dell’installazione LilyPond (ad esempio, ‘/usr/share/lilypond’).

Se c’è un problema, il modo più semplice per individuarlo è lanciare LilyPond usando strace, che permetterà di scoprire quali file mancano.

Eseguire LilyPond

In una gabbia montata con noexec è impossibile eseguire qualsiasi programma esterno. Dunque LilyPond deve essere eseguito con un backend che non richieda tale programma. Come è già stato detto, deve essere eseguito con privilegi di superutente (che ovviamente perderà immediatamente), possibilmente con l’uso di sudo. È una buona idea limitare il numero di secondi di tempo della CPU che LilyPond può usare (ad esempio con ulimit -t), e, se il sistema operativo lo permette, la quantità di memoria che può essere allocata. Si veda anche LilyPond in una gabbia chroot.

-l, --loglevel=LIVELLO

Imposta la verbosità dell’output della console su LIVELLO. I valori possibili sono:

NONE

Nessun output, nemmeno i messaggi di errore.

ERROR

Solo i messaggi di errore, niente avvisi o messaggi di elaborazione.

WARN

Avvisi e messaggi di errore, nessun messaggio di elaborazione.

BASIC_PROGRESS

Messaggi di elaborazione di base (riuscita), avvisi e errori.

PROGRESS

Tutti i messaggi di elaborazione, avvisi e errori.

INFO (predefinito)

Messaggi di elaborazione, avvisi, errori e ulteriori informazioni di esecuzione.

DEBUG

Tutti i messaggi possibili, incluso l’output verboso di debug.

-o, --output=FILE o CARTELLA

Imposta il file di output predefinito FILE oppure, se una cartella con quel nome esiste già, dirige l’output in CARTELLA, prendendo il nome del file dal file di input. In entrambi i casi verrà aggiunto il suffisso appropriato (ad esempio .pdf per il pdf).

--ps

Genera PostScript.

--png

Genera immagini di ogni pagina in formato PNG. Questo implica ‘--ps’. La risoluzione in DPI dell’immagine può essere impostata con

-dresolution=110
--pdf

Genera PDF. Questo implica ‘--ps’.

-v, --version

Mostra informazioni sulla versione.

-V, --verbose

Aumenta la prolissità: mostra i percorsi completi di tutti i file letti e dà informazioni sui tempi.

-w, --warranty

Mostra la garanzia con cui viene distribuito GNU LilyPond. (Distribuito con NESSUNA GARANZIA!)


Opzioni avanzate della linea di comando per lilypond

-d[nome-opzione]=[valore],--define-default=[nome-opzione]=[valore]

Imposta l’equivalente funzione interna di Scheme su valore.

-dbackend=svg

Se non viene specificato un valore, viene usato il valore predefinito. Per disabilitare un’opzione, si può usare il prefisso no- prima di nome-opzione, ad esempio

-dpoint-and-click=#f

è equivalente a

-dno-point-and-click

Sono supportate le seguenti opzioni insieme ai loro rispettivi valori predefiniti:

SimboloValoreSpiegazione/Opzioni
anti-alias-factor1Elabora a una risoluzione più alta (usando un certo fattore) e ridimensiona il risultato per evitare gli ‘artefatti’ nelle immagini PNG.
aux-files#tCrea i file .tex, .texi, .count nel backend EPS.
backendpsSeleziona il backend. I file Postscript (predefinito) includono i tipi di carattere TTF, Type1 e OTF. Non vengono inclusi i sottoinsiemi di questi tipi. Se si usa un set di caratteri ‘orientali’, si possono ottenere file di grosse dimensioni.
epsEncapsulated PostScript. Invia ogni pagina (sistema) in un file ‘EPS’ separato, senza font, e in un unico file ‘EPS’ con tutte le pagine (sistemi) inclusi i font. Questa è la modalità predefinita di lilypond-book.
nullnon produce la stampa della partitura; ha lo stesso effetto di -dno-print-pages.
svgScalable Vector Graphics. Crea un singolo file SVG, senza font incorporati, per ogni pagina dell’output. Si raccomanda di installare i font Century Schoolbook, inclusi nell’installazione di LilyPond, per una resa ottimale. In UNIX basta copiare questi font dalla directory di LilyPond (solitamente ‘/usr/share/lilypond/VERSION/fonts/otf/’) in ‘~/.fonts/’. L’output SVG dovrebbe essere compatibile con qualsiasi editor SVG o user agent. C’è anche un’opzione svg-woff (sotto) per poter usare i file di font woff nel backend SVG.
scmEstrae i comandi di disegno grezzi e interni, basati su Scheme.
check-internal-types#fControlla l’assegnazione di ogni proprietà per i tipi.
clip-systems#fGenera frammenti ritagliati di una partitura.
datadirPrefisso per i file di dati (sola lettura).
debug-gc#fScarica le statistiche sul debug della memoria.
debug-gc-assert-parsed-dead#fPer il debug della memoria: Assicura che tutti i riferimenti agli oggetti analizzati siano eliminati. Questa è un’opzione interna e viene abilitata automaticamente da `-ddebug-gc'.
debug-lexer#fDebug dell’analizzatore lessicale flex.
debug-page-breaking-scoring#fCrea le partiture per diverse configurazioni di interruzione di pagina.
debug-parser#fDebug dell’analizzatore bison.
debug-property-callbacks#fDebug delle catene cicliche di callback.
debug-skylines#fDebug skylines.
delete-intermediate-files#tCancella i file .ps intermedi e inutilizzabili creati durante la compilazione.
dump-cpu-profile#fScarica l’informazione sui tempi (dipendente dal sistema).
dump-profile#fScarica l’informazione sulla memoria e il tempo per ogni file.
dump-signatures#fScarica le firme dell’output di ogni sistema. Usato per testare le regressioni.
eps-box-padding#fSposta il margine sinistro della cornice EPS dell’output della quantità specificata (in mm).
gs-load-fonts#fCarica i font attraverso Ghostscript.
gs-load-lily-fonts#fCarica solo i font LilyPond attraverso Ghostscript.
gui#fEsegue il programma senza stampare messaggi e redirige tutto l’output in un file di log.

Nota per gli utenti Windows: Per impostazione predefinita lilypond.exe stampa tutta l’informazione sull’avanzamento nella finestra dei comandi. lilypond-windows.exe non lo fa e riporta un prompt, privo di informazioni sull’avanzamento, subito nella linea di comando. L’opzione ‘-dgui’ può essere usata in questo caso per redirigere l’output in un file di log.

help#fMostra questo aiuto.
include-book-title-preview#tInclude i titoli dei libri nelle immagini di anteprima.
include-eps-fonts#tInclude i font in file EPS con sistemi separati.
include-settings#fInclude il file per le impostazioni globali, questo viene incluso prima che la partitura sia elaborata.
job-count#fElabora in parallelo, usando il dato numero di lavori.
log-file#f [file]Se la stringa FOO viene assegnata come secondo argomento, redirige l’output nel file FOO.log.
max-markup-depth1024Massima profondità per la struttura del blocco markup. Se un blocco markup ha più livelli, assume che non terminerà da solo, stampa un avviso e restituisce al suo posto un markup vuoto.
midi-extension"midi"Imposta l’estensione predefinita per il file MIDI sulla stringa specificata.
music-strings-to-paths#fConverte le stringhe di testo in percorsi quando i glifi appartengono a un font musicale.
paper-size\"a4\"Imposta la dimensione predefinita del foglio. Nota che la stringa deve essere compresa tra virgolette precedute dal segno di escape.
pixmap-formatpng16mImposta il formato di output di GhostScript per le immagini raster.
point-and-click#fAggiunge i collegamenti ‘punta e clicca’ all’output PDF. Si veda Punta e clicca.
preview#fCrea immagini di anteprima oltre al normale output.

Questa opzione è supportata da tutti i backend; pdf, png, ps, eps e svg, ma non scm. Genera un file di output nella forma mioFile.preview.estensione, contenente i titoli e il primo sistema. Se vengono usati i blocchi \book o \bookpart, i titoli di \book, \bookpart o \score appariranno nell’output, incluso il primo sistema di ogni blocco \score se la variabile print-all-headers di \paper è impostata su #t.

Per impedire il normale output, si usano le opzioni ‘-dprint-pages’ o ‘-dno-print-pages’ in base alle proprie esigenze.

print-pages#tGenera le pagine complete (predefinito). ‘-dno-print-pages’ è utile in combinazione con ‘-dpreview’.
profile-property-accesses#fMantiene una statistica delle chiamate di funzione get_property().
protected-scheme-parsing#tContinua se l’analizzatore coglie degli errori nel codice scheme interno al file di input. Se impostato su #f, in caso di errore si ferma e mostra la traccia di stack.
read-file-list#f [file]Specifica il nome di un file che contiene una lista di file di input da elaborare.
relative-includes#fQuando elabora un comando \include, cerca il file incluso in posizione relativa al file corrente (invece che in posizione assoluta).
resolution101Imposta la risoluzione per generare immagini PNG su un certo valore (in dpi).
safe#fNon si fida dell’input nel file .ly.

Quando la formattazione di LilyPond viene messa a disposizione tramite un server web, si DEVE passare l’opzione ‘--safe’ o l’opzione ‘--jail’. L’opzione ‘--safe’ impedirà che il codice Scheme presente nell’input possa fare uno scempio, ad esempio

#(system "rm -rf /")
{
  c4^$(ly:gulp-file "/etc/passwd")
}

L’opzione ‘-dsafe’ serve a valutare le espressioni Scheme presenti nell’input in uno speciale modulo di sicurezza. Questo modulo di sicurezza è derivato dal modulo GUILE ‘safe-r5rs’, ma aggiunge alcune funzioni del LilyPond API. Queste funzioni sono elencate in ‘scm/safe-lily.scm’.

Inoltre, la modalità sicura non permette le direttive \include e disabilita l’uso del backslash nelle stringhe TeX. In modalità sicura, non è possibile importare le variabili di LilyPond in Scheme.

-dsafenon rileva il sovrautilizzo di risorse. È ancora possibile far sì che il programma rimanga in sospeso per un tempo indefinito, ad esempio alimentando il backend con strutture di dati cicliche. Dunque se si vuole usare LilyPond su un server web pubblicamente accessibile, si deve limitare il processo nell’uso della CPU e della memoria.

La modalità sicura bloccherà la compilazione di molti utili frammenti di codice LilyPond.

L’opzione ‘--jail’ è un’alternativa più sicura, ma richiede più lavoro per configurarla. Si veda Opzioni di base della linea di comando per LilyPond.

separate-log-files#fPer i file di input FILE1.ly, FILE2.ly, etc. salva i dati di log nei file FILE1.log, FILE2.log, …
show-available-fonts#fElenca i nomi di font disponibili.
strict-infinity-checking#fForza il blocco del programma quando si incontrano eccezioni Inf e NaN sui numeri in virgola mobile.
strip-output-dir#tNon usa le directory dei file di input per costruire i nomi dei file di output.
strokeadjust#fForza l’aggiustamento del tratto da parte di PostScript. Questa opzione è utile quando il PDF è generato dall’output PostScript (l’aggiustamento del tratto di solito è abilitato automaticamente per gli strumenti bitmap a bassa risoluzione). Senza questa opzione, le anteprime PDF tendono a produrre larghezze dei gambi molto variabili alle risoluzioni tipiche dei monitor. L’opzione non produce effetti visibili sulla qualità di stampa e causa un notevole aumento della dimensione dei file PDF.
svg-woff#fUsa i file di font woff nel backend SVG.
trace-memory-frequency#fRegistra molte volte al secondo l’uso delle celle da parte di Scheme. Salva i risultati in FILE.stacks e FILE.graph.
trace-scheme-coverage#fRegistra la copertura dei file Scheme in FILE.cov.
verbose#fOutput dettagliato, ovvero livello di log DEBUG (sola lettura).
warning-as-error#fTrasforma tutti i messaggi di avviso e di ‘errore di programmazione’ in errori.

Variabili d’ambiente

lilypond riconosce le seguenti variabili d’ambiente:

LILYPOND_DATADIR

Specifica la directory predefinita in cui saranno cercati i messaggi della localizzazione e i file di dati. Questa directory deve contenere sottodirectory chiamate ‘ly/’, ‘ps/’, ‘tex/’, etc.

LANG

Determina la lingua per i messaggi di avviso.

LILYPOND_LOGLEVEL

Il livello di log (loglevel) predefinito. Se LilyPond viene chiamato senza un livello di log esplicito (ovvero senza l’opzione ‘--loglevel’ della linea di comando), viene usato questo valore.

LILYPOND_GC_YIELD

Una variabile, in forma di percentuale, che regola il modo in cui viene gestita la memoria. Con valori più alti il programma usa più memoria, con valori più bassi usa più tempo della CPU. Il valore predefinito è 70.


LilyPond in una gabbia chroot

Configurare un server perché esegua LilyPond in una gabbia chroot è un lavoro complesso. La procedura è spiegata sotto. Gli esempi si riferiscono a Ubuntu GNU/Linux e potrebbero richiedere l’uso di sudo in alcune situazioni.

Script di esempio per Ubuntu 8.04 a 32-bit

#!/bin/sh
## defaults set here

username=lily
home=/home
loopdevice=/dev/loop0
jaildir=/mnt/lilyloop
# the prefix (without the leading slash!)
lilyprefix=usr/local
# the directory where lilypond is installed on the system
lilydir=/$lilyprefix/lilypond/

userhome=$home/$username
loopfile=$userhome/loopfile
adduser $username
dd if=/dev/zero of=$loopfile bs=1k count=200000
mkdir $jaildir
losetup $loopdevice $loopfile
mkfs -t ext3 $loopdevice 200000
mount -t ext3 $loopdevice $jaildir
mkdir $jaildir/lilyhome
chown $username $jaildir/lilyhome
cd $jaildir

mkdir -p bin usr/bin usr/share usr/lib usr/share/fonts $lilyprefix tmp
chmod a+w tmp

cp -r -L $lilydir $lilyprefix
cp -L /bin/sh /bin/rm bin
cp -L /usr/bin/convert /usr/bin/gs usr/bin
cp -L /usr/share/fonts/truetype usr/share/fonts

# Now the library copying magic
for i in "$lilydir/usr/bin/lilypond" "$lilydir/usr/bin/guile" "/bin/sh"  \
  "/bin/rm" "/usr/bin/gs" "/usr/bin/convert"; do ldd $i | sed 's/.*=>  \
    \/\(.*\/\)\([^(]*\).*/mkdir -p \1 \&\& cp -L \/\1\2 \1\2/' | sed  \
      's/\t\/\(.*\/\)\(.*\) (.*)$/mkdir -p \1 \&\& cp -L \/\1\2 \1\2/'  \
        | sed '/.*=>.*/d'; done | sh -s

# The shared files for ghostscript...
      cp -L -r /usr/share/ghostscript usr/share
# The shared files for ImageMagick
      cp -L -r /usr/lib/ImageMagick* usr/lib

### Now, assuming that you have test.ly in /mnt/lilyloop/lilyhome,
### you should be able to run:
### Note that /$lilyprefix/bin/lilypond is a script, which sets the
### LD_LIBRARY_PATH - this is crucial
      /$lilyprefix/bin/lilypond -jlily,lily,/mnt/lilyloop,/lilyhome test.ly

Note a piè di pagina

[1] Lo status di GUILE non viene resettato dopo l’elaborazione di un file .ly: attenzione a non cambiare alcun valore predefinito dall’interno di Scheme.


Altre lingue: English, deutsch, español, français, magyar, 日本語.
About automatic language selection.

LilyPond — Utilizzo v2.19.10 (ramo di sviluppo).