7fdd5b035f
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>
81 lines
2.0 KiB
Groff
81 lines
2.0 KiB
Groff
.\" (C) 2017-2021, NGINX, Inc.
|
|
.\"
|
|
.Dd March 16, 2021
|
|
.Dt unitd 8
|
|
.Os
|
|
.Sh Name
|
|
.Nm unitd
|
|
.Nd "runs the NGINX Unit daemon"
|
|
.Sh Synopsis
|
|
.Nm
|
|
.Op Fl Fl no-daemon
|
|
.Op Fl Fl control Ar socket
|
|
.Op Fl Fl group Ar name
|
|
.Op Fl Fl user Ar name
|
|
.Op Fl Fl log Ar file
|
|
.Op Fl Fl modules Ar directory
|
|
.Op Fl Fl pid Ar file
|
|
.Op Fl Fl state Ar directory
|
|
.Nm
|
|
.Op Fl h | Fl Fl help | Fl Fl version
|
|
.Sh Description
|
|
NGINX Unit is a polyglot app server, a reverse proxy, and a static file server
|
|
for UNIX-like systems.
|
|
It was built by
|
|
.Xr nginx 8
|
|
team members from
|
|
scratch to be highly efficient and fully configurable at runtime.
|
|
.Sh Options
|
|
.Bl -tag -width indent
|
|
.It Fl h , Fl Fl help
|
|
Displays a summary of Unit's command-line options and their
|
|
compile-time defaults.
|
|
.It Fl Fl version
|
|
Displays Unit's version and the
|
|
.Pa ./configure
|
|
settings it was built with.
|
|
.It Fl Fl no-daemon
|
|
Runs Unit in non-daemon mode.
|
|
.It Fl Fl control Ar socket
|
|
Overrides the control API's socket address in IPv4, IPv6,
|
|
or UNIX-domain format.
|
|
.It Fl Fl group Ar name , Fl Fl user Ar name
|
|
Override group name and user name used to run Unit's non-privileged processes.
|
|
.It Fl Fl log Ar file
|
|
Overrides the pathname for Unit's log.
|
|
.It Fl Fl modules Ar directory
|
|
Overrides the directory path for Unit's language modules
|
|
.Po Pa *.unit.so
|
|
.Pc files .
|
|
.It Fl Fl pid Ar file
|
|
Overrides the pathname for the PID file of Unit's main process.
|
|
.It Fl Fl state Ar directory
|
|
Overrides the directory path for Unit's state storage.
|
|
.El
|
|
.Sh Exit status
|
|
Exit status is 0 on success, or 1 if the daemon encounters an error.
|
|
.Sh Files
|
|
.Bl -tag -width indent
|
|
.It Pa %%PID_PATH%%
|
|
The PID file of Unit's main process.
|
|
.It Pa %%ERROR_LOG_PATH%%
|
|
A general-purpose log for diagnostics and troubleshooting.
|
|
.El
|
|
.Sh Sockets
|
|
.Bl -tag -width indent
|
|
.It Pa %%SOCKET_PATH%%
|
|
The socket address of Unit's control API.
|
|
.El
|
|
.Sh Authors
|
|
(C) 2017-2021, NGINX, Inc.
|
|
.Sh See also
|
|
.Pp
|
|
Website:
|
|
.Pa https://unit.nginx.org
|
|
.Pp
|
|
User mailing list:
|
|
.Pa https://mailman.nginx.org/mailman/listinfo/unit
|
|
.Pp
|
|
GitHub:
|
|
.Pa https://github.com/nginx/unit
|