technocloud-public/nginx-unit
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Docs: not using shouty caps in unitd.8.

Browse Source 
There was a recent unanimous agreement by maintainers of groff, mandoc,
the Linux man-pages, and other relevant programmers, that manual pages
should not use uppercase unnecessarily.  Use of uppercase in the title
and in the section's titles dates from before one could use bold,
italics, and other such formatting, so that it was the way of giving
more importance to certain parts of a page.  Nowadays, we use bold, so
uppercase is unnecessary.

Moreover, using uppercase in the title is bad, since it removes
information.  If we keep the exact casing used in the program (or
function) name, we provide more information.  And anyway, if users want
to read in uppercase, they can program certain mdoc(7) or man(7) macros
to transform their arguments into uppercase.  This could be done via
</etc/groff/mdoc.local> and </etc/groff/man.local>.

There's a plan of transforming OpenBSD pages and the Linux man-pages to
stop using uppercase.  Other projects may join.  That will likely happen
in the following months.  Let's align with this.

Reviewed-by: Artem Konev <a.konev@f5.com>
Signed-off-by: Alejandro Colomar <alx@nginx.com>
This commit is contained in:
Alejandro Colomar
2023-04-26 15:29:00 +02:00
parent 147ee8abd6
commit 7fdd5b035f
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/man/man8/unitd.8.in
View File

@@ -1,12 +1,12 @@
.\" (C) 2017-2021, NGINX, Inc. .\" (C) 2017-2021, NGINX, Inc.
.\" .\"
.Dd March 16, 2021 .Dd March 16, 2021
.Dt UNITD 8 .Dt unitd 8
.Os .Os
.Sh NAME .Sh Name
.Nm unitd .Nm unitd
.Nd "runs the NGINX Unit daemon" .Nd "runs the NGINX Unit daemon"
.Sh SYNOPSIS .Sh Synopsis
.Nm .Nm
.Op Fl Fl no-daemon .Op Fl Fl no-daemon
.Op Fl Fl control Ar socket .Op Fl Fl control Ar socket
@@ -18,14 +18,14 @@
.Op Fl Fl state Ar directory .Op Fl Fl state Ar directory
.Nm .Nm
.Op Fl h | Fl Fl help | Fl Fl version .Op Fl h | Fl Fl help | Fl Fl version
.Sh DESCRIPTION .Sh Description
NGINX Unit is a polyglot app server, a reverse proxy, and a static file server NGINX Unit is a polyglot app server, a reverse proxy, and a static file server
for UNIX-like systems. for UNIX-like systems.
It was built by It was built by
.Xr nginx 8 .Xr nginx 8
team members from team members from
scratch to be highly efficient and fully configurable at runtime. scratch to be highly efficient and fully configurable at runtime.
.Sh OPTIONS .Sh Options
.Bl -tag -width indent .Bl -tag -width indent
.It Fl h , Fl Fl help .It Fl h , Fl Fl help
Displays a summary of Unit's command-line options and their Displays a summary of Unit's command-line options and their
@@ -52,23 +52,23 @@ Overrides the pathname for the PID file of Unit's main process.
.It Fl Fl state Ar directory .It Fl Fl state Ar directory
Overrides the directory path for Unit's state storage. Overrides the directory path for Unit's state storage.
.El .El
.Sh EXIT STATUS .Sh Exit status
Exit status is 0 on success, or 1 if the daemon encounters an error. Exit status is 0 on success, or 1 if the daemon encounters an error.
.Sh FILES .Sh Files
.Bl -tag -width indent .Bl -tag -width indent
.It Pa %%PID_PATH%% .It Pa %%PID_PATH%%
The PID file of Unit's main process. The PID file of Unit's main process.
.It Pa %%ERROR_LOG_PATH%% .It Pa %%ERROR_LOG_PATH%%
A general-purpose log for diagnostics and troubleshooting. A general-purpose log for diagnostics and troubleshooting.
.El .El
.Sh SOCKETS .Sh Sockets
.Bl -tag -width indent .Bl -tag -width indent
.It Pa %%SOCKET_PATH%% .It Pa %%SOCKET_PATH%%
The socket address of Unit's control API. The socket address of Unit's control API.
.El .El
.Sh AUTHORS .Sh Authors
(C) 2017-2021, NGINX, Inc. (C) 2017-2021, NGINX, Inc.
.Sh SEE ALSO .Sh See also
.Pp .Pp
Website: Website:
.Pa https://unit.nginx.org .Pa https://unit.nginx.org