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.

diff --git a/Makefile.am b/Makefile.am
index d9cfbf6ec6f496cdc0132a8df6a50c3ff594e59d..9c2bed22274cbbd817475d37543de474483f2b65 100644 (file)
--- 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 da8688ed302144e9813821968f7820bd56993202..c6da2efdb40f9fea1c1616ecc24c26929f711f13 100644 (file)
--- 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 9f5c0fe625345b3989a528aba3e518093b3abdae..d597841074f68ae6e42b8872da084e4f9d67f8e6 100644 (file)
--- 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 0c30fe4b24131c0d018012ce6b1011cb35f21bea..53cceef80a3096cac9d864fa9fe23f07e64ed77a 100644 (file)
--- 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 345e75ded3b792ed2c7642ae6291363802b1b3f9..2d2de85d3eb1d91077846c84c2fbae2f930462ab 100644 (file)
--- 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 43dd4b15e34ef1e3dd7202b26cec2f9262567179..240a8e45d2c93e8c2acf69408274b63fd583a65b 100644 (file)
--- a/man/shairport-sync.7.xml
+++ b/man/shairport-sync.1.xml
@@ -29,7 +29,7 @@
   OTHER DEALINGS IN THE SOFTWARE.
   -->
 
-  <manpage name="shairport-sync" section="7" desc="AirPlay and AirPlay 2 Audio Player">
+  <manpage name="shairport-sync" section="1" desc="AirPlay and AirPlay 2 Audio Player">
 
        <synopsis>
        <!--

diff --git a/shairport-sync.spec b/shairport-sync.spec
index ed0c3d49ecbb58f3885f4b6e7e92eb027237fcb1..88cb95a780ca31cea12dc9ae52615811806aa5de 100644 (file)
--- a/shairport-sync.spec
+++ b/shairport-sync.spec
@@ -60,7 +60,7 @@ getent passwd %{name} &> /dev/null || useradd --system -c "%{name} User" \
 %files
 %config(noreplace) /etc/shairport-sync.conf
 /usr/bin/shairport-sync
-/usr/share/man/man7/shairport-sync.7.gz
+/usr/share/man/man1/shairport-sync.1.gz
 %{_unitdir}/%{name}.service
 %doc README.md RELEASENOTES.md TROUBLESHOOTING.md
 %license LICENSES