Add relevant help text

This commit is contained in:
2025-07-15 17:06:34 +02:00
parent aaccb1c70d
commit 6b019ed535

View File

@@ -1,12 +1,9 @@
.Dd $Mdocdate$ .Dd July 15, 2025
.Dt valid-utf8 1 .Dt valid-utf8 1
.Os .Os
.Sh NAME .Sh NAME
.Nm valid-utf8 .Nm valid-utf8
.Nd one line about what it does .Nd check whether text is utf-8 encoded or not
.\" .Sh LIBRARY
.\" For sections 2, 3, and 9 only.
.\" Not used in OpenBSD.
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Fl h .Fl h
@@ -17,11 +14,24 @@
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
utility processes files ... utility reads the files given as arguments, and sets its exit status to 0 when
the text has been detected to be valid UTF-8, or to 1 otherwise.
When no file arguments are given, When no file arguments are given,
.Nm .Nm
will read from the standard input. will read from the standard input.
.Pp .Pp
.Nm
will not write anything to the standard output, and will only write error
messages, if any, to the standard error output.
.Pp
This behaviour makes
.Nm
useful as a
.Ar -exec
criterion for the
.Xr find 1
tool.
.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
@@ -29,31 +39,23 @@ Print help text and exit.
.It Fl \-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. .\" For sections 1, 6, and 8 only.
.Nm .Nm
exits 0 on success, and 1 if an error occurs. exits 0 when the text is encoded in valid UTF-8, and 1 otherwise, or 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
.\" Not used in OpenBSD.