Add relevant help text

This commit is contained in:
2025-07-15 16:21:26 +02:00
parent 951a3a45ad
commit 3c0da1ccb6

View File

@@ -1,56 +1,48 @@
.Dd $Mdocdate$ .Dd July 15, 2025
.Dt curly 1 .Dt curly 1
.Os .Os
.Sh NAME .Sh NAME
.Nm curly .Nm curly
.Nd one line about what it does .Nd implementation of the Krul language
.\" .Sh LIBRARY
.\" For sections 2, 3, and 9 only.
.\" Not used in OpenBSD.
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Fl h | v .Fl h
.Nm
.Fl \-version
.Nm .Nm
.Op Ar .Op Ar
.Sh DESCRIPTION .Sh DESCRIPTION
The Without any arguments,
.Nm .Nm
utility processes files ... will solve the Krul puzzle from the
When no file arguments are given, .Lk https://bobpolis.com/krul
.Nm website.
will read from the standard input. .Pp
With arguments, it will act as an interpreter for Krul code that is assumed to
be in the given files, and run it.
.Pp .Pp
The options are as follows: The options are as follows:
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl h, \-help .It Fl h, \-help
Print help text and exit. Print help text and exit.
.It Fl v, \-version .It Fl \-version
Print version info and exit. Print version info and exit.
.El .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 .\" .Sh ENVIRONMENT
.\" For sections 1, 6, 7, and 8 only. .\" For sections 1, 6, 7, and 8 only.
.\" .Sh FILES .\" .Sh FILES
.Sh EXIT STATUS .Sh EXIT STATUS
.\" For sections 1, 6, and 8 only.
.Nm .Nm
exits 0 on success, and 1 if an error occurs. exits 0 on success, and 1 if an error occurs.
.\" .Sh EXAMPLES .\" .Sh EXAMPLES
.\" .Sh DIAGNOSTICS .\" .Sh DIAGNOSTICS
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. .\" 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 .\" .Sh SEE ALSO
.\" .Xr foobar 1 .\" .Xr foobar 1
.\" .Sh STANDARDS .\" .Sh STANDARDS
.\" .Sh HISTORY .\" .Sh HISTORY
.Sh AUTHORS .Sh AUTHORS
Bob Polis .An Bob Polis
.\" .Sh CAVEATS .\" .Sh CAVEATS
.\" .Sh BUGS .\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS .\" .Sh SECURITY CONSIDERATIONS