Options avancées de lilypond
L’option ‘-d’ est l’interface de la ligne de commande à la
fonction Scheme de LilyPond ly:set-option. Par voie de
conséquence, toutes les options listées ci-après peuvent aussi se
définir au sein même des fichiers ‘.ly’.
-
-d,--define-default=nom-option[=valeur] -
-d,--define-default=no-nom-option Affecte la valeur Scheme valeur à l’option interne nom-option du programme. Par exemple, l’option en ligne de commande
-dbackend=svg
équivaut à
#(ly:set-option 'backend 'svg)
dans un fichier source LilyPond.
En l’absence de valeur, le programme utilisera #t, ce qui peut conduire à des résultats inescomptés dès lors que le type escompté de valeur n’est pas boléen. Préfixer nom-option d’un
no-permet de désactiver une option, autrement dit affecte#fà valeur. Ainsi,-dno-point-and-click
revient au même que
-dpoint-and-click='#f'
[Note : le caractère ‘#’ introduit un commentaire dans de nombreux
shells ; c’est pourquoi nous recommandons de toujours borner par
des ' les expressions qui le contiennent.]
Voici les différentes options disponibles, ainsi que leur valeur par
défaut. Au sein de code Scheme, la valeur des options est interprétée
par la fonction ly:get-option.
-
anti-alias-factornum Adopte une résolution supérieure, selon le facteur num donné (entier positif inférieur ou égal à 8), puis réduit au niveau du résultat afin d’éviter les « distorsions » des images
PNG. La valeur par défaut est de1.-
aux-filesbool Si bool est fixé à
#t, génère les fichiers.tex,.texiet.countpour le moteur de rendueps. Cette option est principalement destinée àlilypond-book. La valeur par défaut est#t.-
backendsymbole Détermine symbole comme moteur de traitement de LilyPond. Les valeurs possibles sont :
-
ps Il s’agit du réglage par défaut. Les fichiers PostScript incluent les fontes
TTF,Type1etOTF, et ce en intégralité. Si vous utilisez des jeux de caractères orientaux, le fichier aura vite fait d’atteindre une taille conséquente.Pour l’obtention d’un fichier PDF, c’est aussi le moteur
psqui est utilisé. Les données PS sont ensuite retraitées parps2pdf, script de Ghostscript, qui par défaut extrait des sous-ensembles des fontes.-
svg Génère du Scalable Vector Graphics. Cette option permet de créer un fichier SVG par page. Les glyphes musicaux sont codés en tant que graphiques vectoriels mais les fontes textuelles ne sont pas incorporées aux fichiers ‘SVG’ résultants. Quel que soit le programme utilisé pour visionner ces fichiers, il devra avoir accès aux fontes en question pour pouvoir afficher correctement les textes et paroles. Il est préférable de ne pas recourir aux « alias de police » ni aux listes de fontes si la visionneuse de fichier SVG ne peut le traîter correctement. L’option supplémentaire
--svg-woff– voir ci-après – permet d’utiliser les fontes WOFF (Web Open Font Format) avec le moteursvg.
-
-
clip-systemsbool Si bool est déterminé à
#t, extrait des fragments musicaux d’une partition. Ceci requiert que la fonctionclip-regionsa été définie au sein du bloc\layout– voir Extraction de fragments musicaux. Bien entendu, aucun fragment ne sera extrait si l’on utilise l’option ‘-dno-print-pages’. La valeur par défaut est#f.-
compile-scheme-codebool Utilise le compilateur de Guile pour traiter du code Scheme, au lieu de l’évaluateur. Pour de plus amples informations, voir Débogage de code Scheme.
-
cropbool Si bool est déterminé à
#t, un second fichier PDF sera créé (avec l’extension ‘.cropped.pdf’) ainsi que son rendu sous forme d’image (avec l’extension ‘.cropped.png’). Ce fichier résultant (musique et entêtes) sera à la taille de l’image générée, sans marge. Dans le cas où est utilisée l’option ‘--svg’ sera alors produit un fichier SVG (avec l’extension ‘.cropped.svg’). Dès lors que sont utilisées les options ‘--eps’ ou ‘--ps’, un fichier réduit PS (avec l’extension ‘.cropped.eps’) sera généré en lieu et place d’un PDF réduit. La valeur par défaut est#f.Notez bien que cette option n’est, à ce jour, pas très adaptée dans le cadre d’une sortie comportant plusieurs systèmes puisque l’espace les séparant est supprimé.
-
datadir Détermine le préfixe des fichiers de données (lecture seule).
-
debug-evalbool Si bool est déterminé à
#t, LilyPond utilisera le l’évaluateur de déboguage Scheme qui affichera les traçage et les numéros de ligne en cas d’erreur. La valeur par défaut est#f, mais#tlorsque--verboseest utilisé.-
debug-skylinesbool Si bool est déterminé à
#t, permet le débogage des lignes d’horizon. La valeur par défaut est#f.-
delete-intermediate-filesbool Si bool est déterminé à
#t, supprime les fichiers ‘.ps’ inutiles créés lors de la compilation. La valeur par défaut est#t.-
embed-source-codebool Si bool est déterminé à
#t, intègre les fichiers source LilyPond au document PDF généré. La valeur par défaut est#f.-
eps-box-paddingnum Décale le bord gauche du typon EPS d’une valeur num donnée en millimètres. La valeur par défaut est
#f, autrement dit sans décalage.-
font-export-dirchaîne Détermine à chaîne le répertoire dans lequel exporter les fontes en tant que fichiers PostScript. Ceci est tout à fait approprié lorsque l’on crée un fichier PDF sans y incorporer les fontes dans un premier temps, et laisse Ghostscript le faire par la suite comme indiqué ci-dessous.
$ lilypond -dfont-export-dir=fontdir -dgs-never-embed-fonts foo.ly $ gs -q -dBATCH -dNOPAUSE -sDEVICE=pdfwrite \ -sOutputFile=foo.embedded.pdf foo.pdf fontdir/*.font.psNote : Contrairement à
font-ps-resdir, cette méthode ne permet pas d’incorporer de fonte CID avec une version de Ghostscript égale ou supérieure à 9.26.Note : Identique à
font-ps-resdir, cette option ignore les fontes TrueType dans la mesure où les incorporer a posteriori cause une altération des caractères. L’utilisation degs-never-embed-fonts, dans la mesure où elle incorpore les fontes TrueType en dépit de ce qu’elle prétend d’après son nom, permet d’éviter les caractères altérés.La valeur par défaut est
#f, autrement dit absence d’export.-
font-ps-resdirchaîne Détermine à chaîne le répertoire dans lequel sera construit le sous-ensemble des ressources PostScript utilisé pour l’incoporation ultérieure des fontes. Ceci est tout à fait approprié lorsque l’on crée un fichier PDF sans y incorporer les fontes dans un premier temps, et laisse Ghostscript le faire par la suite comme indiqué ci-dessous.
$ lilypond -dfont-ps-resdir=resdir -dgs-never-embed-fonts foo.ly $ gs -q -dBATCH -dNOPAUSE -sDEVICE=pdfwrite \ -I resdir -I resdir/Font \ -sOutputFile=foo.embedded.pdf foo.pdfNote : Il vaut mieux éviter que le nom du répertoire contienne le mot ‘Resource’, qui a une signification particulière lorsqu’utilisé avec une option
-Ide Ghostscript.Note : Contrairement à
font-export-dir, cette méthode permet l’incorporation de fontes CID avec une version de Ghostscript égale ou supérieure à 9.26.Note : Identique à
font-export-dir, cette option ignore les fontes TrueType dans la mesure où les incorporer a posteriori cause une altération des caractères. L’utilisation degs-never-embed-fonts, dans la mesure où elle incorpore les fontes TrueType en dépit de ce qu’elle prétend d’après son nom, permet d’éviter les caractères altérés.La valeur par défaut est
#f, autrement dit absence de construction d’un sous-ensemble.-
gs-load-fontsbool Si bool est déterminé à
#t, charge les fontes grâce à Ghostscript. Cette option a pour conséquence que les fichiers générés par LilyPond ne contiendront que les références des fontes, qui seront ensuite résolues en fontes réelles lors de l’étape de retraitement par Ghostscript. La valeur par défaut est#f.-
gs-load-lily-fontsbool Si bool est déterminé à
#t, limite les fontes chargées par Ghostscript aux seules fontes LilyPond. Cette option a pour conséquence que les fichiers générés par LilyPond ne contiendront les références que des fontes musicales de LilyPond, qui seront ensuite résolues en fontes réelles lors de l’étape de retraitement par Ghostscript. Les autres fontes sont générées normalement. La valeur par défaut est#f.-
gs-never-embed-fontsbool Si bool est déterminé à
#t, intime à Ghostscript d’embarquer les fontes uniquement au format TrueType, sans exception. La valeur par défaut est#f.-
helpbool Si bool est déterminé à
#t, affiche cette aide. La valeur par défaut est#f.-
include-book-title-previewbool Si bool est déterminé à
#t, inclut les titres de l’ouvrage dans les images de prévisualisation. La valeur par défaut est#t.-
include-eps-fontsbool Si bool est déterminé à
#t, inclut les fontes dans chaque fichier EPS contenant un système. La valeur par défaut est#t.-
include-settingschaîne Inclut le fichier chaîne contenant les réglages globaux, qui sera inclus avant traitement de la partition. La valeur par défaut est
#f, autrement dit absence de fichier de réglages.-
job-countnum Traite plusieurs fichiers en parallèle, selon le nombre num de jobs. La valeur par défaut est
#f, autrement dit sans traitement parallèle.-
log-filechaîne Redirige la sortie dans le fichier journal ‘chaîne.log’. La valeur par défaut est
#f, autrement dit absence de fichier de journalisation.-
max-markup-depthnum Détermine à num la profondeur maximale de l’arborescence de markups. Si un markup était plus profond, part du principe qu’on n’aboutira pas, émet un avertissement et renvoie alors un markup vide. La valeur par défaut est
1024.-
midi-extensionchaîne Détermine à chaîne l’extension par défaut des fichiers MIDI.La valeur par défaut est
"midi".-
music-strings-to-pathsbool Si bool est déterminé à
#t, convertit les chaînes textuelles en chemins lorsque les glyphes font partie d’une fonte musicale. La valeur par défaut est#f.-
paper-sizechaîne-entre-guillemets Détermine la taille par défaut du papier à chaîne-entre-guillemets. Veillez à ne pas oublier d’encadrer la valeur par des guillemets échappés (
\").La valeur par défaut est"\"a4\"".-
pixmap-formatsymbole Détermine le format de sortie en images pixélisées pour Ghostscript à symbole. La valeur par défaut est
png16m.-
png-widthlargeur -
png-heighthauteur Dans le cas d’une sortie PNG, détermine la largeur et la hauteur, en pixels, des images créées. En l’absence de l’une de ces options, l’autre dimension sera calculée relativement à la boîte EPS englobante tout en maintenant le ration d’aspect.
En comlément de l’option ‘--png’, les options ‘--eps’, ‘-dcrop’ ou ‘-dpreview’ devraient permettre une mise à l’échelle correcte sans détourage.
L’option ‘-dresolution’ est ignorée.
Notez la présence d’un bogue dans les versions de ghostscript inférieures à 9.52 avec ces deux options : l’image PNG produite sera vide dès lors que la hauteur est supérieure à la largeur.
-
point-and-clickbool Si bool est déterminé à
#t, ajoute les liens « point & click » à la sortie PDF ou SVG – voir Pointer-cliquer. La valeur par défaut est#t.-
previewbool Si bool est déterminé à
#t, génère une prévisualisation en plus de la sortie normale. La valeur par défaut est#f.Cette option, disponible dans tous les formats de sortie imprimables – rendus
pdf,png,ps,epsetsvg– génère un fichier de la forme ‘fichierSource.preview.rendu’ comprenant le titrage et le premier système. S’il existe plusieurs sections\bookou\bookpart, ce fichier contiendra les titrage et premier système de chacun des\book,\bookpartet\score, dès lors que la variableprint-all-headersdu bloc\paperest activée.Pour l’éviter, utilisez conjointement l’une des options ‘-dprint-pages’ ou ‘-dno-print-pages’ selon vos besoins.
-
print-pagesbool Si bool est déterminé à
#t, génère l’intégralité des pages de la partition. La valeur par défaut est#t.L’option ‘-dno-print-pages’ est particulièrement utile lorsqu’utilisée conjointement avec les options ‘-dpreview’ et ‘-dcrop’.
-
protected-scheme-parsingbool Si bool est déterminé à
#t, continue en dépit des erreurs que l’analyseur syntaxique détecterait dans du code Scheme inclus. Lorsque basculé sur#f, stoppe le traitement s’il y a erreur et affiche une trace de la pile. La valeur par défaut est#t.-
relative-includesbool Face à une instruction
\include, recherche les fichiers à inclure relativement à l’endroit où se trouve le fichier en cours de traitement si bool est déterminé à#t, plutôt que par rapport au fichier maître. La valeur par défaut est#t.-
resolutionnum Détermine la résolution des pixmaps
PNGà générer à numdpi. La valeur par défaut est101.-
separate-log-filesbool Pour les fichiers ‘fichier1.ly’, ‘fichier2.ly’, etc. enregistre le déroulement dans les journaux ‘fichier1.log’, ‘fichier2.log’… si bool est déterminé à
#t. La valeur par défaut est#f.-
separate-page-formatssymbole Liste des formats (
svg,pdf,png, oueps), séparés par des virgules, à utiliser pour les images séparées des pages pourlilypond-book.-
show-available-fontsbool Si bool est déterminé à
#t, liste le nom des fontes disponibles tel que le ressort la bibliothèque fontconfig. LilyPond ajoute à cette liste les réglages et la configuration de fontconfig. La valeur par défaut est#t.-
strip-output-dirbool Si bool est déterminé à
#t, supprime, lors du nommage des fichiers résultants, la partie correspondant au répertoire des fichiers sources. La valeur par défaut est#t.-
strokeadjustbool Si bool est déterminé à
#t, force l’ajustement des traits PostScript. Cette option trouve toute son utilité pour générer du PDF à partir de PostScript – l’ajustement des traits est en principe automatiquement activé pour les périphériques bitmap à faible résolution. Sans cette option, les visionneurs de PDF ont tendance à ne pas rendre de manière constante l’épaisseur des hampes dans les résolutions habituelles des écrans. Bien que n’affectant pas notoirement la qualité d’impression, cette option accroit notablement la taille des fichiers PDF. La valeur par défaut est#f.-
svg-woffbool Cette option est obligatoire dès lors que sont utilisées, avec le moteur
svg, les fontes Web Open Font Format (WOFF). Un fichier SVG sera généré pour chacune des pages produites. En dehors des glyphes musicaux propres à LilyPond, aucune autre information ne sera incluse. Quelque soit le visionneur de SVG utilisé, il devra avoir à disposition les fontes requises pour pouvoir afficher les éléments textuels et les paroles. Dans la mesure où le visionneur pourrait ne pas savoir le gérer, mieux vaut s’abstenir de recourir aux alias ou listes de fontes. La valeur par défaut est#f.Lorsque celles-ci sont utilisées correctement, nul n’est besoin d’installer les fontes que les fichiers SVG utiliseront dans l’environnement du visionneur. Néanmoins, LilyPond ne dispose pas de fichier de fonte
wofftextuelle. La présence du fichier de fontewoffest un prérequis.-
tall-page-formatssymbole Liste des formats (
svg,pdf,png, oueps), séparés par des virgules, à utiliser pour l’image pleine page pourlilypond-book.-
use-paper-size-for-pagebool Si bool est déterminé à
#t(valeur par défaut), chaque page est dimensionnée au format du papier, tout en éliminant les parties qui pourraient déborder. Lorsque cette option est déterminée à#f, la feuille sera redimsensionnée pour contenir autant que nécessaire.-
verbose Passe en mode verbeux, ce qui correspond à un niveau de journalisation
DEBUG(lecture seule).-
warning-as-errorbool Si bool est déterminé à
#t, considère tous les messages d’avertissement et « erreur de programmation » comme étant de véritables erreurs. La valeur par défaut est#f.