* Updated help and manpage.
This commit is contained in:
parent
7c5074176c
commit
4b1d3a28f5
2 changed files with 31 additions and 13 deletions
|
@ -4,7 +4,7 @@ TOIlet \- display large colourful characters
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B toilet
|
.B toilet
|
||||||
[
|
[
|
||||||
.B \-htv
|
.B \-hkostvSW
|
||||||
] [
|
] [
|
||||||
.B \-d
|
.B \-d
|
||||||
.I fontdirectory
|
.I fontdirectory
|
||||||
|
@ -65,6 +65,20 @@ Specify the directory in which to look for fonts. The default value is set
|
||||||
at build time and usually defaults to
|
at build time and usually defaults to
|
||||||
.B @datarootdir@/figlet.
|
.B @datarootdir@/figlet.
|
||||||
.TP
|
.TP
|
||||||
|
.B \-s, \-S, \-k, \-W, \-o
|
||||||
|
Select character composition rules.
|
||||||
|
.B \-S
|
||||||
|
sets smushing (nicely merging glyphs),
|
||||||
|
.B \-k
|
||||||
|
sets kerning (rendering subcharacters as close to each other as possible),
|
||||||
|
.B \-W
|
||||||
|
renders characters at their full width and
|
||||||
|
.B \-o
|
||||||
|
sets overlapping (glyphs slightly overlap the previous one).
|
||||||
|
.B \-s
|
||||||
|
(default behaviour) uses the font's smushing information if any, otherwise
|
||||||
|
forces overlapping, or does nothing if the glyph only has one subcharacter.
|
||||||
|
.TP
|
||||||
.B \-w, \-\-width <width>
|
.B \-w, \-\-width <width>
|
||||||
Set the output width. By default,
|
Set the output width. By default,
|
||||||
.B TOIlet
|
.B TOIlet
|
||||||
|
|
28
src/main.c
28
src/main.c
|
@ -217,7 +217,7 @@ int main(int argc, char *argv[])
|
||||||
|
|
||||||
#if defined(HAVE_GETOPT_H)
|
#if defined(HAVE_GETOPT_H)
|
||||||
# define USAGE \
|
# define USAGE \
|
||||||
"Usage: toilet [ -htv ] [ -d fontdirectory ]\n" \
|
"Usage: toilet [ -hkostvSW ] [ -d fontdirectory ]\n" \
|
||||||
" [ -f fontfile ] [ -F filter ] [ -w outputwidth ]\n" \
|
" [ -f fontfile ] [ -F filter ] [ -w outputwidth ]\n" \
|
||||||
" [ -I infocode ] [ -E format ] [ message ]\n"
|
" [ -I infocode ] [ -E format ] [ message ]\n"
|
||||||
#else
|
#else
|
||||||
|
@ -249,6 +249,8 @@ static void usage(void)
|
||||||
# ifdef HAVE_GETOPT_LONG
|
# ifdef HAVE_GETOPT_LONG
|
||||||
printf(" -f, --font <name> select the font\n");
|
printf(" -f, --font <name> select the font\n");
|
||||||
printf(" -d, --directory <dir> specify font directory\n");
|
printf(" -d, --directory <dir> specify font directory\n");
|
||||||
|
printf(" -s, -S, -k, -W, -o render mode (default smushing, force smushing,\n");
|
||||||
|
printf(" kerning, full width, overlap)\n");
|
||||||
printf(" -w, --width <width> set output width\n");
|
printf(" -w, --width <width> set output width\n");
|
||||||
printf(" -t, --termwidth adapt to terminal's width\n");
|
printf(" -t, --termwidth adapt to terminal's width\n");
|
||||||
printf(" -F, --filter <filters> apply one or several filters to the text\n");
|
printf(" -F, --filter <filters> apply one or several filters to the text\n");
|
||||||
|
@ -263,17 +265,19 @@ static void usage(void)
|
||||||
printf(" -I, --infocode <code> print FIGlet-compatible infocode\n");
|
printf(" -I, --infocode <code> print FIGlet-compatible infocode\n");
|
||||||
printf(" -v, --version output version information and exit\n");
|
printf(" -v, --version output version information and exit\n");
|
||||||
# else
|
# else
|
||||||
printf(" -f <name> select the font\n");
|
printf(" -f <name> select the font\n");
|
||||||
printf(" -d <dir> specify font directory\n");
|
printf(" -d <dir> specify font directory\n");
|
||||||
printf(" -w <width> set output width\n");
|
printf(" -s, -S, -k, -W, -o render mode (default smushing, force smushing,\n");
|
||||||
printf(" -t adapt to terminal's width\n");
|
printf(" kerning, full width, overlap)\n");
|
||||||
printf(" -F <filters> apply one or several filters to the text\n");
|
printf(" -w <width> set output width\n");
|
||||||
printf(" -F list list available filters\n");
|
printf(" -t adapt to terminal's width\n");
|
||||||
printf(" -E <format> select export format\n");
|
printf(" -F <filters> apply one or several filters to the text\n");
|
||||||
printf(" -E list list available export formats\n");
|
printf(" -F list list available filters\n");
|
||||||
printf(" -h display this help and exit\n");
|
printf(" -E <format> select export format\n");
|
||||||
printf(" -I <code> print FIGlet-compatible infocode\n");
|
printf(" -E list list available export formats\n");
|
||||||
printf(" -v output version information and exit\n");
|
printf(" -h display this help and exit\n");
|
||||||
|
printf(" -I <code> print FIGlet-compatible infocode\n");
|
||||||
|
printf(" -v output version information and exit\n");
|
||||||
# endif
|
# endif
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
Loading…
Reference in a new issue