3d76bc5996
Not setting it produces the default value of 'BSD' or 'GNU', depending on the software formatting the manual page. We're neither, so let's specify our project name. See groff_mdoc(7). While mandoc_mdoc(7) formally says that .Os is only for the operating system, and not for the package name, that's an oversimplification, and only meant for software inherent to the OS. For portable software, mandoc(1)'s (and OpenBSD's) maintainer Ingo Schwarze agreed that it is more sensible to specify the project name (and optionally, the version). 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 NGINX Unit
|
|
.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 modulesdir Ar directory
|
|
.Op Fl Fl pid Ar file
|
|
.Op Fl Fl statedir 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 modulesdir 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 statedir 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
|