commit 38c37fe52cae083ff7a0f818d364e4341720b4bc
parent 6a585109cd20d01edb3c76cd80849fae4b541990
Author: nibo <nibo@relim.de>
Date: Sat, 25 Jan 2025 12:14:12 +0100
Improve documenation
Diffstat:
| M | Makefile | | | 5 | ++++- |
| M | lorid_config.5 | | | 76 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------------- |
2 files changed, 58 insertions(+), 23 deletions(-)
diff --git a/Makefile b/Makefile
@@ -29,7 +29,9 @@ install: compile
# mkdir -p ${PREFIX}/include
# cp lorid.h ${PREFIX}/include
mkdir -p ${MANPREFIX}/man1
- cp lorid.1 ${MANPREFIX}/man1/lorid.1
+ cp lorid.1 ${MANPREFIX}/man1/
+ mkdir -p ${MANPREFIX}/man5
+ cp lorid_config.5 ${MANPREFIX}/man5/
mkdir -p ${PREFIX}/share/lorid/
cp ./misc/ChordProSymbols.ttf ${PREFIX}/share/lorid/
uninstall:
@@ -37,5 +39,6 @@ uninstall:
# rm ${PREFIX}/lib/liblorid.so*
# rm ${PREFIX}/include/lorid.h
rm ${MANPREFIX}/man1/lorid.1
+ rm ${MANPREFIX}/man5/lorid_config.5
rm ${PREFIX}/share/lorid/ChordProSymbols.ttf
.PHONY: compile debug clean fontconfig parser lib install uninstall
diff --git a/lorid_config.5 b/lorid_config.5
@@ -46,6 +46,8 @@ mode = String
=> allowed values: "strict", "relaxed"
+=> default value: "strict"
+
.RS 4
Currently this setting doesn't have any effect.
.RE
@@ -54,39 +56,70 @@ system = String
=> allowed values: "common", "german", "scandinavian", "latin", "roman", "nashville", "<custom>"
+=> default value: "common"
+
.RS 4
Specify a predefined or custom notation system from the [notes] section.
-When parsing chordpro text only chords from this selected notation system are recognized. Notice that unrecognized chords are only problematic if you want to transpose them or show their chord diagrams.
+When parsing chordpro text only chords from this selected notation system are recognized. Notice that unrecognized chords are only problematic if you want to transpose them or show their chord diagram.
.RE
.SS [output]
system = String
=> allowed values: "common", "german", "scandinavian", "latin", "roman", "nashville", "<custom>"
+=> default value: "common"
+
.RS 4
Specify a predefined or custom notation system from the [notes] section.
When generating the PDF file chords from this selected notation system will be printed.
.RE
-page_no_position = String
+start_song_on_new_page = Boolean
+
+=> default value: true
+
+.RS 4
+Every song starts at the top of the page.
+.RE
+
+.SS [output.page_no]
+
+At the bottom of every page a page number can be shown.
+
+Page numbers that belong to pages of the table of contents will be shown in the roman numeral system (I, II, III).
+
+Page numbers that belong to pages that show songs will be shown in the western arabic numeral system (1, 2, 3).
+
+show = Boolean
+
+=> default value: true
+
+.RS 4
+Control whether to show a page number at the bottom of every page.
+.RE
+
+alignment = String
=> allowed values: "left", "center", "right"
+=> default value: "center"
+
.RS 4
-At the bottom of each PDF page a page number will be shown.
This controls the page number's alignment.
.RE
.SS [output.toc]
show = Boolean
+=> default value: false
+
.RS 4
Control whether to show the table of contents.
.RE
title = String
-=> allowed values: any
+=> default value: "Table Of Contents"
.RS 4
The specified string will be shown centered and above the table of contents.
@@ -95,6 +128,8 @@ The specified string will be shown centered and above the table of contents.
.SS [output.chord_diagram]
show = Boolean
+=> default value: true
+
.RS 4
Control whether to show chord diagrams of recognized chords at the bottom of the first page of the song.
.RE
@@ -103,6 +138,8 @@ instrument = String
=> allowed values: "guitar", "keyboard", "mandolin", "ukulele"
+=> default value: "guitar"
+
.RS 4
The instrument controls which style the chord diagram has.
@@ -122,7 +159,7 @@ This section controls the output of the {chorus} directive.
label = String
-=> allowed values: any
+=> default value: "Chorus"
.RS 4
If you didn't specify a directive label this is the default label text.
@@ -130,6 +167,8 @@ If you didn't specify a directive label this is the default label text.
quote = Boolean
+=> default value: false
+
.RS 4
Control whether to print the last previously defined chorus.
.RE
@@ -152,42 +191,39 @@ In this section you can control the style of various parts of the song or the PD
.BR comment_italic ,
.BR comment_box .
-If you set the color of something you can provide a hex color code or one of the following predefined color values:
-.BR \e"red" ,
-.BR "green" ,
+If you set the color of something you can provide a 4 or 7 characters long hex color code or one of the following predefined color values:
+.BR \(dqred\(dq ,
+.BR \(dqgreen\(dq ,
+.BR \(dqblue\(dq ,
+.BR \(dqyellow\(dq ,
+.BR \(dqmagenta\(dq ,
+.BR \(dqcyan\(dq ,
+.BR \(dqwhite\(dq ,
+.BR \(dqgrey\(dq ,
+.BR \(dqblack\(dq .
.SS [output.styles.<style>]
foreground_color = String
-=> allowed values: 4 or 7 characters long hex color code, "red", "green", "blue", "yellow", "magenta", "cyan", "white", "grey", "black"
-
background_color = String
-=> allowed values: 4 or 7 characters long hex color code, "red", "green", "blue", "yellow", "magenta", "cyan", "white", "grey", "black"
-
underline_style = String
=> allowed values: "single", "double", "none"
underline_color = String
-=> allowed values: 4 or 7 characters long hex color code, "red", "green", "blue", "yellow", "magenta", "cyan", "white", "grey", "black"
-
overline_style = String
=> allowed values: "single", "double", "none"
overline_color = String
-=> allowed values: 4 or 7 characters long hex color code, "red", "green", "blue", "yellow", "magenta", "cyan", "white", "grey", "black"
-
strikethrough = Boolean
strikethrough_color = String
-=> allowed values: 4 or 7 characters long hex color code, "red", "green", "blue", "yellow", "magenta", "cyan", "white", "grey", "black"
-
boxed = Boolean
.RS 4
@@ -196,14 +232,10 @@ Control whether a rectangle is drawn around the text.
boxed_color = String
-=> allowed values: 4 or 7 characters long hex color code, "red", "green", "blue", "yellow", "magenta", "cyan", "white", "grey", "black"
-
rise = Float
href = String
-=> allowed values: any
-
.RS 4
Clicking on the corresponding text tries to open the provided href in a browser.
.RE