From 1266eda80c2f3b67d50b13d88d1ea51729eab772 Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Mon, 24 Apr 2023 17:59:34 +0200 Subject: Docs: moved uintd.8 to man8/ subdirectory. Reviewed-by: Artem Konev Signed-off-by: Alejandro Colomar --- docs/man/man8/unitd.8.in | 80 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 docs/man/man8/unitd.8.in (limited to 'docs/man/man8/unitd.8.in') diff --git a/docs/man/man8/unitd.8.in b/docs/man/man8/unitd.8.in new file mode 100644 index 00000000..46182781 --- /dev/null +++ b/docs/man/man8/unitd.8.in @@ -0,0 +1,80 @@ +.\" (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. +.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 -- cgit From 147ee8abd650c373cb1022dad2a9a0b8522aea8b Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Wed, 26 Apr 2023 15:02:09 +0200 Subject: Docs: removed '-v' from unitd.8. This short option is not really supported. Probably it was just a typo. Reviewed-by: Artem Konev Signed-off-by: Alejandro Colomar --- docs/man/man8/unitd.8.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/man/man8/unitd.8.in') diff --git a/docs/man/man8/unitd.8.in b/docs/man/man8/unitd.8.in index 46182781..d3c662d1 100644 --- a/docs/man/man8/unitd.8.in +++ b/docs/man/man8/unitd.8.in @@ -17,7 +17,7 @@ .Op Fl Fl pid Ar file .Op Fl Fl state Ar directory .Nm -.Op Fl h | Fl Fl help | v | Fl Fl version +.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. @@ -30,7 +30,7 @@ scratch to be highly efficient and fully configurable at runtime. .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 +.It Fl Fl version Displays Unit's version and the .Pa ./configure settings it was built with. -- cgit From 7fdd5b035f3b22f1424115c9b31ad675ee1619aa Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Wed, 26 Apr 2023 15:29:00 +0200 Subject: Docs: not using shouty caps in unitd.8. 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 and . 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 Signed-off-by: Alejandro Colomar --- docs/man/man8/unitd.8.in | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'docs/man/man8/unitd.8.in') diff --git a/docs/man/man8/unitd.8.in b/docs/man/man8/unitd.8.in index d3c662d1..88e91d5a 100644 --- a/docs/man/man8/unitd.8.in +++ b/docs/man/man8/unitd.8.in @@ -1,12 +1,12 @@ .\" (C) 2017-2021, NGINX, Inc. .\" .Dd March 16, 2021 -.Dt UNITD 8 +.Dt unitd 8 .Os -.Sh NAME +.Sh Name .Nm unitd .Nd "runs the NGINX Unit daemon" -.Sh SYNOPSIS +.Sh Synopsis .Nm .Op Fl Fl no-daemon .Op Fl Fl control Ar socket @@ -18,14 +18,14 @@ .Op Fl Fl state Ar directory .Nm .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 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 +.Sh Options .Bl -tag -width indent .It Fl h , Fl Fl help 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 Overrides the directory path for Unit's state storage. .El -.Sh EXIT STATUS +.Sh Exit status Exit status is 0 on success, or 1 if the daemon encounters an error. -.Sh FILES +.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 +.Sh Sockets .Bl -tag -width indent .It Pa %%SOCKET_PATH%% The socket address of Unit's control API. .El -.Sh AUTHORS +.Sh Authors (C) 2017-2021, NGINX, Inc. -.Sh SEE ALSO +.Sh See also .Pp Website: .Pa https://unit.nginx.org -- cgit From c2bb129e47f579833e2f9cc7c9b7c80a831c0cba Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Wed, 26 Apr 2023 15:40:20 +0200 Subject: Docs: documenting the renamed directory flags in unitd.8. Reviewed-by: Artem Konev Signed-off-by: Alejandro Colomar --- docs/man/man8/unitd.8.in | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/man/man8/unitd.8.in') diff --git a/docs/man/man8/unitd.8.in b/docs/man/man8/unitd.8.in index 88e91d5a..5f50e561 100644 --- a/docs/man/man8/unitd.8.in +++ b/docs/man/man8/unitd.8.in @@ -13,9 +13,9 @@ .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 modulesdir Ar directory .Op Fl Fl pid Ar file -.Op Fl Fl state Ar directory +.Op Fl Fl statedir Ar directory .Nm .Op Fl h | Fl Fl help | Fl Fl version .Sh Description @@ -43,13 +43,13 @@ or UNIX-domain format. 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 +.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 state Ar directory +.It Fl Fl statedir Ar directory Overrides the directory path for Unit's state storage. .El .Sh Exit status -- cgit From 3d76bc59962b74a74642dd7002554dd3bd4e86f1 Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Wed, 26 Apr 2023 15:50:19 +0200 Subject: Docs: setting the project name in unitd.8. 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 Signed-off-by: Alejandro Colomar --- docs/man/man8/unitd.8.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/man/man8/unitd.8.in') diff --git a/docs/man/man8/unitd.8.in b/docs/man/man8/unitd.8.in index 5f50e561..1425120c 100644 --- a/docs/man/man8/unitd.8.in +++ b/docs/man/man8/unitd.8.in @@ -2,7 +2,7 @@ .\" .Dd March 16, 2021 .Dt unitd 8 -.Os +.Os NGINX Unit .Sh Name .Nm unitd .Nd "runs the NGINX Unit daemon" -- cgit From f994b232ff6720fce6bdaa9843239f7899950041 Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Wed, 26 Apr 2023 15:55:57 +0200 Subject: Docs: updated unitd.8 date. We've applied significant changes to the page, so let's update the date. While we're at it, let's change it to use ISO 8601 format for the date. Reviewed-by: Artem Konev Signed-off-by: Alejandro Colomar --- docs/man/man8/unitd.8.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/man/man8/unitd.8.in') diff --git a/docs/man/man8/unitd.8.in b/docs/man/man8/unitd.8.in index 1425120c..dceaded3 100644 --- a/docs/man/man8/unitd.8.in +++ b/docs/man/man8/unitd.8.in @@ -1,6 +1,6 @@ .\" (C) 2017-2021, NGINX, Inc. .\" -.Dd March 16, 2021 +.Dd 2023-04-26 .Dt unitd 8 .Os NGINX Unit .Sh Name -- cgit From 8e849db4e633ad5e4039bd1e5185c599ef805f4e Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Wed, 26 Apr 2023 16:18:29 +0200 Subject: Docs: changed Authors section to Copyright section in unitd.8. The Authors section is meant to list the main authors. However, the section only contained the copyright notice, so the Copyright section seems more appropriate. While we change that, it makes sense to also specify the license, and update the copyright year. Reviewed-by: Liam Crilly Reviewed-by: Artem Konev Signed-off-by: Alejandro Colomar --- docs/man/man8/unitd.8.in | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/man/man8/unitd.8.in') diff --git a/docs/man/man8/unitd.8.in b/docs/man/man8/unitd.8.in index dceaded3..f4b1e54f 100644 --- a/docs/man/man8/unitd.8.in +++ b/docs/man/man8/unitd.8.in @@ -66,8 +66,10 @@ A general-purpose log for diagnostics and troubleshooting. .It Pa %%SOCKET_PATH%% The socket address of Unit's control API. .El -.Sh Authors -(C) 2017-2021, NGINX, Inc. +.Sh Copyright +(C) 2017-2023, NGINX, Inc. +.Pp +SPDX-License-Identifier: Apache-2.0 .Sh See also .Pp Website: -- cgit From 7417987923114a30713f7df3905365f297df0daa Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Thu, 27 Apr 2023 14:21:20 +0200 Subject: Docs: using appropriate mdoc(7) macros for URIs in unitd.8. Reviewed-by: Artem Konev Signed-off-by: Alejandro Colomar --- docs/man/man8/unitd.8.in | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) (limited to 'docs/man/man8/unitd.8.in') diff --git a/docs/man/man8/unitd.8.in b/docs/man/man8/unitd.8.in index f4b1e54f..bda97bfd 100644 --- a/docs/man/man8/unitd.8.in +++ b/docs/man/man8/unitd.8.in @@ -72,11 +72,8 @@ The socket address of Unit's control API. SPDX-License-Identifier: Apache-2.0 .Sh See also .Pp -Website: -.Pa https://unit.nginx.org +.Lk https://unit.nginx.org Website .Pp -User mailing list: -.Pa https://mailman.nginx.org/mailman/listinfo/unit +.Lk https://mailman.nginx.org/mailman/listinfo/unit "User mailing list" .Pp -GitHub: -.Pa https://github.com/nginx/unit +.Lk https://github.com/nginx/unit GitHub -- cgit From 8843e30e8275aa70bf7eec11709cd5d12e32b4ae Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Mon, 8 May 2023 18:07:10 +0200 Subject: Docs: removed incorrect Pp call in unitd.8. Pp is used to separate paragraphs, not to introduce them. A Pp macro call right after Sh is wrong, and it is ignored by the formatter, which reports a warning about it. Signed-off-by: Alejandro Colomar --- docs/man/man8/unitd.8.in | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/man/man8/unitd.8.in') diff --git a/docs/man/man8/unitd.8.in b/docs/man/man8/unitd.8.in index bda97bfd..a43e671f 100644 --- a/docs/man/man8/unitd.8.in +++ b/docs/man/man8/unitd.8.in @@ -71,7 +71,6 @@ The socket address of Unit's control API. .Pp SPDX-License-Identifier: Apache-2.0 .Sh See also -.Pp .Lk https://unit.nginx.org Website .Pp .Lk https://mailman.nginx.org/mailman/listinfo/unit "User mailing list" -- cgit