Edit man page to contain actual help text

This commit is contained in:
2025-07-10 14:30:53 +02:00
parent 79a5b9f7ac
commit 0d675f7793

View File

@@ -1,41 +1,74 @@
.Dd $Mdocdate$
.Dd July 10, 2025
.Dt autogram 1
.Os
.Sh NAME
.Nm autogram
.Nd one line about what it does
.\" .Sh LIBRARY
.\" For sections 2, 3, and 9 only.
.\" Not used in OpenBSD.
.Nd generate self-referent sentences
.Sh SYNOPSIS
.Nm
.Fl h | v
.Fl h
.Nm
.Op Ar
.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 processes files ...
When no file arguments are given,
.Nm
will read from the standard input.
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
.Sq relaxed .
.It Fl h, \-help
Print help text and exit.
.It Fl v, \-version
.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 .
.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 CONTEXT
.\" For section 9 functions only.
.\" .Sh IMPLEMENTATION NOTES
.\" Not used in OpenBSD.
.\" .Sh RETURN VALUES
.\" For sections 2, 3, and 9 function return values only.
.\" .Sh ENVIRONMENT
.\" For sections 1, 6, 7, and 8 only.
.\" .Sh FILES
.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
@@ -43,8 +76,6 @@ 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 ERRORS
.\" For sections 2, 3, 4, and 9 errno settings only.
.\" .Sh SEE ALSO
.\" .Xr foobar 1
.\" .Sh STANDARDS