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 --- auto/make | 4 +-- docs/man/man8/unitd.8.in | 80 ++++++++++++++++++++++++++++++++++++++++++++++++ docs/man/unitd.8.in | 80 ------------------------------------------------ pkg/deb/Makefile | 2 +- pkg/deb/debian/rules.in | 4 +-- pkg/rpm/Makefile | 2 +- 6 files changed, 86 insertions(+), 86 deletions(-) create mode 100644 docs/man/man8/unitd.8.in delete mode 100644 docs/man/unitd.8.in diff --git a/auto/make b/auto/make index 0890b0c3..ecf31826 100644 --- a/auto/make +++ b/auto/make @@ -305,12 +305,12 @@ END cat << END >> $NXT_MAKEFILE -$NXT_BUILD_DIR/share/man/man8/unitd.8: docs/man/unitd.8.in \\ +$NXT_BUILD_DIR/share/man/man8/unitd.8: docs/man/man8/unitd.8.in \\ $NXT_BUILD_DIR/include/nxt_auto_config.h sed -e "s|%%ERROR_LOG_PATH%%|$NXT_LOG|" \\ -e "s|%%PID_PATH%%|$NXT_PID|" \\ -e "s|%%SOCKET_PATH%%|$NXT_CONTROL|" \\ - < docs/man/unitd.8.in > \$@ + < docs/man/man8/unitd.8.in > \$@ END 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 diff --git a/docs/man/unitd.8.in b/docs/man/unitd.8.in deleted file mode 100644 index 46182781..00000000 --- a/docs/man/unitd.8.in +++ /dev/null @@ -1,80 +0,0 @@ -.\" (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 diff --git a/pkg/deb/Makefile b/pkg/deb/Makefile index c7c36bf7..575a0984 100644 --- a/pkg/deb/Makefile +++ b/pkg/deb/Makefile @@ -200,7 +200,7 @@ debuild/unit_$(VERSION).orig.tar.gz: | debuild/$(SRCDIR)/debian cd ../.. && tar -czf pkg/deb/debuild/$(SRCDIR).tar.gz \ --transform "s#^#$(SRCDIR)/#" \ LICENSE NOTICE CHANGES README.md CONTRIBUTING.md configure auto src \ - test tools version go pkg/contrib docs/man/unitd.8.in + test tools version go pkg/contrib docs/man/man8/unitd.8.in mv debuild/$(SRCDIR).tar.gz debuild/unit_$(VERSION).orig.tar.gz cd debuild && tar zxf unit_$(VERSION).orig.tar.gz diff --git a/pkg/deb/debian/rules.in b/pkg/deb/debian/rules.in index 46286e83..0d7cf830 100644 --- a/pkg/deb/debian/rules.in +++ b/pkg/deb/debian/rules.in @@ -40,8 +40,8 @@ config.env.%: njs cp -Pa $(CURDIR)/README.md $(BUILDDIR_$*)/ cp -Pa $(CURDIR)/CONTRIBUTING.md $(BUILDDIR_$*)/ cp -Pa $(CURDIR)/go $(BUILDDIR_$*)/ - mkdir -p $(BUILDDIR_$*)/docs/man - cp -Pa $(CURDIR)/docs/man/unitd.8.in $(BUILDDIR_$*)/docs/man/ + mkdir -p $(BUILDDIR_$*)/docs/man/man8 + cp -Pa $(CURDIR)/docs/man/man8/unitd.8.in $(BUILDDIR_$*)/docs/man/man8/ touch $@ configure.unit: config.env.unit diff --git a/pkg/rpm/Makefile b/pkg/rpm/Makefile index 584f2d3a..d3cc34bd 100644 --- a/pkg/rpm/Makefile +++ b/pkg/rpm/Makefile @@ -193,7 +193,7 @@ rpmbuild/SOURCES/unit-$(VERSION).tar.gz: cd ../.. && tar -czf pkg/rpm/rpmbuild/SOURCES/unit-$(VERSION).tar.gz \ --transform "s#^#unit-$(VERSION)/#" \ LICENSE NOTICE CHANGES README.md CONTRIBUTING.md configure auto src \ - test tools version go pkg/contrib docs/man/unitd.8.in + test tools version go pkg/contrib docs/man/man8/unitd.8.in unit: check-build-depends-unit rpmbuild/SPECS/unit.spec rpmbuild/SOURCES/unit-$(VERSION).tar.gz @echo "===> Building $@ package" ; \ -- cgit