From 8ae635e78ed93d7029689f39b8c62ded9eef1453 Mon Sep 17 00:00:00 2001 From: Klemens Nanni Date: Sat, 27 Jan 2024 19:40:04 +0100 Subject: [PATCH] Move shairport-sync manual from section 7 to 1 From mandoc man(1) [-s] section: 1 General commands (tools and utilities). [...] 7 Miscellaneous information. From GNU man(1) DESCRIPTION: 1 Executable programs or shell commands [...] 7 Miscellaneous (including macro packages and conventions), e.g. man(7), groff(7) shairport-sync is an executable, shairport-sync(1) ought to be its documentation, not merely miscellaneous information. OpenBSD adjusts this in its audio/shairport-sync port/package ever since. --- Makefile.am | 2 +- docker/Dockerfile | 2 +- docker/classic/Dockerfile | 2 +- man/Makefile | 12 ++++++------ man/{shairport-sync.7 => shairport-sync.1} | 2 +- man/{shairport-sync.7.xml => shairport-sync.1.xml} | 2 +- shairport-sync.spec | 2 +- 7 files changed, 12 insertions(+), 12 deletions(-) rename man/{shairport-sync.7 => shairport-sync.1} (99%) rename man/{shairport-sync.7.xml => shairport-sync.1.xml} (99%) diff --git a/Makefile.am b/Makefile.am index d9cfbf6ec..9c2bed222 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ ARFLAGS = cr -man_MANS = $(top_srcdir)/man/shairport-sync.7 +man_MANS = $(top_srcdir)/man/shairport-sync.1 lib_pair_ap_a_CFLAGS = -Wall -g -DCONFIG_GCRYPT -pthread lib_tinyhttp_a_CFLAGS = -pthread diff --git a/docker/Dockerfile b/docker/Dockerfile index da8688ed3..c6da2efdb 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -95,7 +95,7 @@ RUN apk -U add \ # Copy build files. COPY --from=builder /shairport-sync/build/install/usr/local/bin/shairport-sync /usr/local/bin/shairport-sync -COPY --from=builder /shairport-sync/build/install/usr/local/share/man/man7 /usr/share/man/man7 +COPY --from=builder /shairport-sync/build/install/usr/local/share/man/man1 /usr/share/man/man1 COPY --from=builder /nqptp/nqptp /usr/local/bin/nqptp COPY --from=builder /usr/local/lib/libalac.* /usr/local/lib/ COPY --from=builder /shairport-sync/build/install/etc/shairport-sync.conf /etc/ diff --git a/docker/classic/Dockerfile b/docker/classic/Dockerfile index 9f5c0fe62..d59784107 100644 --- a/docker/classic/Dockerfile +++ b/docker/classic/Dockerfile @@ -75,7 +75,7 @@ RUN apk -U add \ # Copy build files. COPY --from=builder /shairport-sync/build/install/usr/local/bin/shairport-sync /usr/local/bin/shairport-sync -COPY --from=builder /shairport-sync/build/install/usr/local/share/man/man7 /usr/share/man/man7 +COPY --from=builder /shairport-sync/build/install/usr/local/share/man/man1 /usr/share/man/man1 COPY --from=builder /usr/local/lib/libalac.* /usr/local/lib/ COPY --from=builder /shairport-sync/build/install/etc/shairport-sync.conf /etc/ COPY --from=builder /shairport-sync/build/install/etc/shairport-sync.conf.sample /etc/ diff --git a/man/Makefile b/man/Makefile index 0c30fe4b2..53cceef80 100644 --- a/man/Makefile +++ b/man/Makefile @@ -1,11 +1,11 @@ -shairport-sync.7: shairport-sync.7.xml - xmltoman shairport-sync.7.xml > shairport-sync.7 +shairport-sync.1: shairport-sync.1.xml + xmltoman shairport-sync.1.xml > shairport-sync.1 -shairport-sync.html: shairport-sync.7.xml - xsltproc xmltoman.xsl shairport-sync.7.xml > shairport-sync.html +shairport-sync.html: shairport-sync.1.xml + xsltproc xmltoman.xsl shairport-sync.1.xml > shairport-sync.html -all: shairport-sync.7 shairport-sync.html +all: shairport-sync.1 shairport-sync.html clean: - rm shairport-sync.7 + rm shairport-sync.1 rm shairport-sync.html diff --git a/man/shairport-sync.7 b/man/shairport-sync.1 similarity index 99% rename from man/shairport-sync.7 rename to man/shairport-sync.1 index 345e75ded..2d2de85d3 100644 --- a/man/shairport-sync.7 +++ b/man/shairport-sync.1 @@ -1,4 +1,4 @@ -.TH shairport-sync 7 User Manuals +.TH shairport-sync 1 User Manuals .SH NAME shairport-sync \- AirPlay and AirPlay 2 Audio Player .SH SYNOPSIS diff --git a/man/shairport-sync.7.xml b/man/shairport-sync.1.xml similarity index 99% rename from man/shairport-sync.7.xml rename to man/shairport-sync.1.xml index 43dd4b15e..240a8e45d 100644 --- a/man/shairport-sync.7.xml +++ b/man/shairport-sync.1.xml @@ -29,7 +29,7 @@ OTHER DEALINGS IN THE SOFTWARE. --> - +