lorid

convert chordpro to pdf
git clone git://git.relim.de/lorid.git
Log | Files | Refs | README | LICENSE

lorid.1 (1785B)

      1 .TH LORID "1" "December 2024" "User Commands"
      2 .SH NAME
      3 lorid \- convert chordpro to pdf
      4 .SH SYNOPSIS
      5 .B lorid
      6 [-o
      7 .IR PATH ]
      8 [-c
      9 .IR CONFIGFILE ]
     10 [-pvVh]
     11 .RI [ FILE
     12 \&...]
     13 .SH DESCRIPTION
     14 .PP
     15 .B lorid
     16 reads text from one or more
     17 .IR FILE 's
     18 and if no
     19 .I FILE
     20 was provided then from stdin.
     21 .B lorid
     22 assumes the text is encoded in UTF-8.
     23 The text will be parsed according to the chordpro specification
     24 and then converted to pdf. These two steps can be altered by
     25 changing the configuration file.
     26 
     27 .BR -o ,
     28 .B --output
     29 .I PATH
     30 .RS 7
     31 Specify an output file or folder.
     32 
     33 If you specify a file the generated pdf file will be saved
     34 as that file.
     35 
     36 If you specify a folder the generated pdf file will be
     37 saved in that folder with a filename also generated by
     38 lorid.
     39 
     40 If lorid finds exactly one song and you provided a file to parse
     41 from then lorid will replace the file extension with '.pdf' and
     42 use that as output filename.
     43 
     44 If lorid finds exactly one song but you didn't provide a file
     45 to parse from then lorid will generate a filename based on the
     46 song title in kebab case.
     47 
     48 If lorid finds more than one song it will use the
     49 filename 'collection-of-songs.pdf'.
     50 .RE
     51 
     52 .BR -c ,
     53 .B --config
     54 .I CONFIGFILE
     55 .RS 7
     56 Specify a configuration file.
     57 
     58 By default the file
     59 .B ~/.config/lorid/config.toml
     60 will be used as the configuration file.
     61 .RE
     62 
     63 .BR -p ,
     64 .B --print-default-config
     65 .RS 7
     66 Print the default configuration as TOML.
     67 .RE
     68 
     69 .BR -v ,
     70 .B --verbose
     71 .RS 7
     72 Print INFO messages to stderr.
     73 
     74 By default only WARN and ERR messages are printed to stderr.
     75 .RE
     76 
     77 .BR -V ,
     78 .B --version
     79 .RS 7
     80 Print the program version.
     81 .RE
     82 
     83 .BR -h ,
     84 .B --help
     85 .RS 7
     86 Open
     87 .BR lorid 's
     88 man page.
     89 .RE
     90 
     91 .SH SEE ALSO
     92 .BR lorid_config (5)
     93 
     94 .SH CHORDPRO
     95 .PP
     96 You find the chordpro specification at https://www.chordpro.org/chordpro/.