summaryrefslogtreecommitdiffhomepage
path: root/docs/man
diff options
context:
space:
mode:
authorArtem Konev <artem.konev@nginx.com>2021-03-24 15:43:16 +0000
committerArtem Konev <artem.konev@nginx.com>2021-03-24 15:43:16 +0000
commit4d28ea2e24d8815e65c100aa6256cc00dc9d5479 (patch)
tree8a192a6508ddd1fd8b108f2da05924709f8ad03b /docs/man
parent699a3ea2ebc86f9e9dc9d59e1d9db488ac4ff352 (diff)
downloadunit-4d28ea2e24d8815e65c100aa6256cc00dc9d5479.tar.gz
unit-4d28ea2e24d8815e65c100aa6256cc00dc9d5479.tar.bz2
Added a man page.
Reviewed at https://rb.nginx.com/r/165/
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/unitd.8.in79
1 files changed, 79 insertions, 0 deletions
diff --git a/docs/man/unitd.8.in b/docs/man/unitd.8.in
new file mode 100644
index 00000000..4d79d023
--- /dev/null
+++ b/docs/man/unitd.8.in
@@ -0,0 +1,79 @@
+.\" (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 | v | 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 v , 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.
+.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