xref: /unit/docs/man/unitd.8.in (revision 1824:e4a48cdb5d07)
1.\" (C) 2017-2021, NGINX, Inc.
2.\"
3.Dd March 16, 2021
4.Dt UNITD 8
5.Os
6.Sh NAME
7.Nm unitd
8.Nd "runs the NGINX Unit daemon"
9.Sh SYNOPSIS
10.Nm
11.Op Fl Fl no-daemon
12.Op Fl Fl control Ar socket
13.Op Fl Fl group Ar name
14.Op Fl Fl user Ar name
15.Op Fl Fl log Ar file
16.Op Fl Fl modules Ar directory
17.Op Fl Fl pid Ar file
18.Op Fl Fl state Ar directory
19.Nm
20.Op Fl h | Fl Fl help | v | Fl Fl version
21.Sh DESCRIPTION
22NGINX Unit is a polyglot app server, a reverse proxy, and a static file server
23for UNIX-like systems.
24It was built by
25.Xr nginx 8
26team members from
27scratch to be highly efficient and fully configurable at runtime.
28.Sh OPTIONS
29.Bl -tag -width indent
30.It Fl h , Fl Fl help
31Displays a summary of Unit's command-line options and their
32compile-time defaults.
33.It Fl v , Fl Fl version
34Displays Unit's version and the
35.Pa ./configure
36settings it was built with.
37.It Fl Fl no-daemon
38Runs Unit in non-daemon mode.
39.It Fl Fl control Ar socket
40Overrides the control API's socket address in IPv4, IPv6,
41or UNIX-domain format.
42.It Fl Fl group Ar name , Fl Fl user Ar name
43Override group name and user name used to run Unit's non-privileged processes.
44.It Fl Fl log Ar file
45Overrides the pathname for Unit's log.
46.It Fl Fl modules Ar directory
47Overrides the directory path for Unit's language modules
48.Po Pa *.unit.so
49.Pc files .
50.It Fl Fl pid Ar file
51Overrides the pathname for the PID file of Unit's main process.
52.It Fl Fl state Ar directory
53Overrides the directory path for Unit's state storage.
54.El
55.Sh EXIT STATUS
56Exit status is 0 on success, or 1 if the daemon encounters an error.
57.Sh FILES
58.Bl -tag -width indent
59.It Pa %%PID_PATH%%
60The PID file of Unit's main process.
61.It Pa %%ERROR_LOG_PATH%%
62A general-purpose log for diagnostics and troubleshooting.
63.El
64.Sh SOCKETS
65.Bl -tag -width indent
66.It Pa %%SOCKET_PATH%%
67The socket address of Unit's control API.
68.El
69.Sh AUTHORS
70(C) 2017-2021, NGINX, Inc.
71.Sh SEE ALSO
72.Pp
73Website:
74.Pa https://unit.nginx.org
75.Pp
76User mailing list:
77.Pa https://mailman.nginx.org/mailman/listinfo/unit
78.Pp
79GitHub:
80.Pa https://github.com/nginx/unit
81