Files
autogram/man/man1/autogram.1
Bob Polis 4cf02e2794 Improve man page
Add -s, --start option explanation, and specify defaults for options.
2025-07-10 14:39:51 +02:00

95 lines
2.3 KiB
Groff

.Dd July 10, 2025
.Dt autogram 1
.Os
.Sh NAME
.Nm autogram
.Nd generate self-referent sentences
.Sh SYNOPSIS
.Nm
.Fl h
.Nm
.Fl \-version
.Nm
.Op Fl a Ar relaxed | strict | pangram
.Op Fl i Ar max-iter
.Op Fl l Ar language
.Op Fl s Ar start-of-sentemce
.Op Fl v
.Sh DESCRIPTION
The
.Nm
utility generates self-referential sentences that report how many times letters
of the alphabet occur in them.
The numbers are written textually, which makes the sentences self-referential.
.Pp
Three kinds of sentences can be generated: relaxed, strict, or pangram.
.Bl -tag -width Ds
.It relaxed
Only letters that actually occur in the sentence are mentioned.
Counts of one are acceptable.
.It strict
Only letters that actually occur in the sentence are mentioned.
Counts of one are not allowed.
.It pangram
Counts for every letter of the alphabet are mentioned, which makes this a
pangram.
A pangram is any sentence containing every letter of the alphabet, like the
famous
.Dq The quick brown fox jumped over the lazy dog .
.El
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl a, \-autogram Ar relaxed | strict | pangram
Specify the desired type of autogram.
Default is
.Ar relaxed .
.It Fl h, \-help
Print help text and exit.
.It Fl i, \-max-iter Ar count
Specify the maximum number of iterations, before a new seed is chosen.
Default is 10.
.It Fl l, \-lang Ar en | nl
Language for the sentence.
Choose between English
.Ar en
or Dutch
.Ar nl .
Default is
.Ar en .
.It Fl s, \-start Ar start-of-sentence
Specify the text with which the sentence should start.
Default is
.Dq This sentence contains .
.It Fl v, \-verbose
When specified,
.Nm
will show some feedback about the number of iterations it performs.
.It Fl \-version
Print version info and exit.
.El
.\" .Sh ENVIRONMENT
.\" For sections 1, 6, 7, and 8 only.
.Sh FILES
.Bl -tag -width Ds
.It Pa $PREFIX/share/autogram/numerals.db
The sqlite3 database file containing the numerals for the different languages.
.El
.Sh EXIT STATUS
.\" For sections 1, 6, and 8 only.
.Nm
exits 0 on success, and 1 if an error occurs.
.\" .Sh EXAMPLES
.\" .Sh DIAGNOSTICS
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
.\" .Sh SEE ALSO
.\" .Xr foobar 1
.\" .Sh STANDARDS
.\" .Sh HISTORY
.Sh AUTHORS
Bob Polis
.\" .Sh CAVEATS
.\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS
.\" Not used in OpenBSD.