From e3951cb5a38a4cede8c4908a8e5256fa77b114f1 Mon Sep 17 00:00:00 2001 From: Tom Eastep Date: Sun, 18 Dec 2016 16:16:50 -0800 Subject: [PATCH] Re-add volume 8 manpages Signed-off-by: Tom Eastep --- Shorewall-core/manpages/shorewall.xml | 376 ++++++++++++------- Shorewall-lite/install.sh | 8 + Shorewall-lite/manpages/shorewall-lite.xml | 46 +++ Shorewall/install.sh | 14 +- Shorewall6-lite/manpages/shorewall6-lite.xml | 46 +++ Shorewall6/manpages/shorewall6.xml | 45 +++ 6 files changed, 384 insertions(+), 151 deletions(-) create mode 100644 Shorewall-lite/manpages/shorewall-lite.xml create mode 100644 Shorewall6-lite/manpages/shorewall6-lite.xml create mode 100644 Shorewall6/manpages/shorewall6.xml diff --git a/Shorewall-core/manpages/shorewall.xml b/Shorewall-core/manpages/shorewall.xml index 74838fc22..61ba0c3cd 100644 --- a/Shorewall-core/manpages/shorewall.xml +++ b/Shorewall-core/manpages/shorewall.xml @@ -19,12 +19,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -37,12 +37,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -50,12 +50,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -65,12 +65,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -80,11 +80,11 @@ - shorewall + shorewall[6] | - -options + options @@ -104,24 +104,24 @@ - shorewall + shorewall[6][-lite] | - -options + options - shorewall + shorewall[6][-lite] | - -options + options open-number | @@ -131,11 +131,11 @@ - shorewall + shorewall[6] | - -options + options @@ -157,12 +157,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -175,12 +175,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -189,12 +189,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -202,11 +202,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -220,12 +220,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -234,12 +234,12 @@ - shorewall + shorewall[6] | - -options + options @@ -250,12 +250,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -263,32 +263,32 @@ - shorewall + shorewall[6][-lite] | - -options + options - shorewall + shorewall[-lite] | - -options + options - shorewall + shorewall[-lite] | - -options + options @@ -302,11 +302,11 @@ - shorewall + shorewall[-lite] | - -options + options @@ -315,11 +315,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -328,12 +328,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -341,11 +341,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -355,12 +355,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -368,11 +368,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -381,9 +381,9 @@ - shorewall + shorewall[6][-lite] - -options + options source dest @@ -392,12 +392,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -406,12 +406,12 @@ - shorewall + shorewall[6] | - -options + options - @@ -420,12 +420,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -433,11 +433,11 @@ - shorewall + shorewall[6] | - -options + options @@ -457,11 +457,11 @@ - shorewall + shorewall[6] | - -options + options @@ -481,11 +481,11 @@ - shorewall + shorewall[6] | - -options + options @@ -505,12 +505,12 @@ - shorewall + shorewall[6][-lite] | - -options + options chain @@ -518,12 +518,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -545,12 +545,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -559,12 +559,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -574,12 +574,12 @@ - shorewall + shorewall[6] | - -options + options @@ -593,11 +593,11 @@ - shorewall + shorewall[6] | - -options + options @@ -611,12 +611,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -625,22 +625,22 @@ - shorewall + shorewall[6][-lite] | - -options + options - shorewall + shorewall[6][-lite] | - -options + options @@ -650,11 +650,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -672,11 +672,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -686,11 +686,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -699,11 +699,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -712,11 +712,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -726,11 +726,11 @@ - shorewall + shorewall[6] | - -options + options @@ -739,11 +739,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -753,11 +753,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -765,11 +765,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -779,12 +779,12 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -804,35 +804,35 @@ - shorewall + shorewall[6][-lite] | - -options + options - shorewall + shorewall[6][-lite] | - -options + options - shorewall + shorewall[6] | - -options + options @@ -842,11 +842,11 @@ - shorewall + shorewall[6] | - -options + options @@ -868,11 +868,11 @@ - shorewall + shorewall[6][-lite] | - -options + options @@ -883,7 +883,51 @@ Description The shorewall utility is used to control the Shoreline Firewall - (Shorewall). + (Shorewall), Shorewall Firewall 6 (Shorewall6), Shorewall Firewall Lite + (Shorewall-lite) and Shorewall Firewall 6 Lite (Shorewall6-lite). The + utility may be accessed under four different names: + + + + shorewall + + + Controls the Shorewall configuration when Shorewall is + installed. If Shorewall is not installed, the + shorewall command controls Shorewall-lite if it + is installed. If neither Shorewall nor Shorewall-lite is installed, + the shorewall command controls Shorewall6-lite if + it is installed. + + + + + shorewall6 + + + The shorewall6 command controls Shorewall6 + when Shorewall6 is installed. + + + + + shorewall-lite + + + The shorewall-lite command controls + Shorewall-lite when Shorewall-lite is installed. + + + + + shorewall6-lite + + + The shorewall6-lite command controls + Shorewall6-lite when Shorewall6-lite is installed. + + + @@ -922,42 +966,88 @@ - When the Shorewall6 package is installed, the - option is used to cause shorewall commands to operate - on the Shorewall6 configuration. In other words, "shorewall -6 - ..." is equivalent to the 5.0 command "shorewall6 - ...". + Other options are: - Similarly, when Shorewall is not installed but both Shorewall-lite - and Shorewall6-lite are installed, the option causes - shorewall commands to operate on the Shorewall6-lite - configuration. + + + - Finally, when both the standard product (Shorewall or Shorewall6) - and the corresponding -lite product(s) are installed, the - option causes shorewall commands to - operate on the -lite configuration rather than the standard configuration. - In other words "shorewall -l ..." is equivalent to the - 5.0 "shorewall-lite -l ..." command and - "shorewall -6l ..." is equivalent to - "shorewall6-lite ...". + + Causes the command to operate on the Shorewall configuration + or the Shorewall-lite configuration. It is the default when either + of those products is installed and when the command is + shorewall or + shorewall-lite. + + - The remaining options control the amount of - output that the command produces. They consist of a sequence of the - letters v and q. If the options are omitted, the amount of output - is determined by the setting of the VERBOSITY parameter in shorewall.conf(5). Each - v adds one to the effective verbosity and - each q subtracts one from the effective - VERBOSITY. Alternatively, v may be - followed immediately with one of -1,0,1,2 to specify a specify VERBOSITY. - There may be no white-space between v and - the VERBOSITY. + + - The options may also include the letter - which causes all progress messages to be - timestamped. + + Causes the command to operate on the Shorewall6 or + Shorewall6-lite configuration. It is the default when only + Shorewall6-lite is installed and when the command is + shorewall6 or + shorewall6-lite. + + + + + + + + Causes the command to operate on either Shorewall-lite or + Shorewall-6 lite and is the default when Shorewall is not installed + or when the command is shorewall-lite or + shorewall6-lite. + + + + + [verbosity] + + + Alters the amount of output produced by the command. If + neither the -v nor -q option are specified, the amount of output is + determined by the VERBOSITY setting in shorewall.conf(5) + (shorewall6.conf(5)). + + When no verbosity is specified, + each instance of this option causes 1 to be added to the effective + verbosity. When verbosity (-1,0,1 or 2) + is given, the command is executed at the specified VERBOSITY. There + may be no white-space between -v + and the verbosity. + + + + + + + + Alters the amount of output produced by the command. If + neither the -v nor -q option are specified, the amount of output is + determined by the VERBOSITY setting in shorewall.conf(5) + (shorewall6.conf(5)). + + Each instance of this option causes 1 to be subtracted from + the effective verbosity. + + + + + + + + Causes causes all progress messages to be timestamped. + + + diff --git a/Shorewall-lite/install.sh b/Shorewall-lite/install.sh index ef41b672e..7dce2293c 100755 --- a/Shorewall-lite/install.sh +++ b/Shorewall-lite/install.sh @@ -504,6 +504,14 @@ if [ -d manpages -a -n "$MANDIR" ]; then echo "Man page $f.gz installed to ${DESTDIR}${MANDIR}/man5/$f.gz" done + mkdir -p ${DESTDIR}${MANDIR}/man8/ + + for f in *.8; do + gzip -c $f > $f.gz + install_file $f.gz ${DESTDIR}${MANDIR}/man8/$f.gz 644 + echo "Man page $f.gz installed to ${DESTDIR}${MANDIR}/man8/$f.gz" + done + cd .. echo "Man Pages Installed" diff --git a/Shorewall-lite/manpages/shorewall-lite.xml b/Shorewall-lite/manpages/shorewall-lite.xml new file mode 100644 index 000000000..446268edb --- /dev/null +++ b/Shorewall-lite/manpages/shorewall-lite.xml @@ -0,0 +1,46 @@ + + + + + shorewall-lite + + 8 + + Administrative Commands + + + + shorewall-lite + + Administration tool for Shoreline Firewall Lite + (Shorewall-lte) + + + + + shorewall-lite + + | + + -options + + command [ + command-arguments ] + + + + + Description + + The shorewall-lite utility is used to control the Shoreline Firewall + Lite (Shorewall-lite). + + Beginning with Shorewall 5.1.0, shorewall6-lite + is a symbolic link pointing to the shorewall(8) executable who + executes the command as if its + and options had been + specified. + + diff --git a/Shorewall/install.sh b/Shorewall/install.sh index 1f450b493..e6e24d464 100755 --- a/Shorewall/install.sh +++ b/Shorewall/install.sh @@ -1186,15 +1186,13 @@ for f in *.5; do echo "Man page $f.gz installed to ${DESTDIR}${MANDIR}/man5/$f.gz" done -if [ $PRODUCT = shorewall ]; then - [ -n "$INSTALLD" ] || mkdir -p ${DESTDIR}${MANDIR}/man5/ +[ -n "$INSTALLD" ] || mkdir -p ${DESTDIR}${MANDIR}/man8/ - for f in *.8; do - gzip -9c $f > $f.gz - run_install $INSTALLD -m 0644 $f.gz ${DESTDIR}${MANDIR}/man8/$f.gz - echo "Man page $f.gz installed to ${DESTDIR}${MANDIR}/man8/$f.gz" - done -fi +for f in *.8; do + gzip -9c $f > $f.gz + run_install $INSTALLD -m 0644 $f.gz ${DESTDIR}${MANDIR}/man8/$f.gz + echo "Man page $f.gz installed to ${DESTDIR}${MANDIR}/man8/$f.gz" +done cd .. diff --git a/Shorewall6-lite/manpages/shorewall6-lite.xml b/Shorewall6-lite/manpages/shorewall6-lite.xml new file mode 100644 index 000000000..de4004468 --- /dev/null +++ b/Shorewall6-lite/manpages/shorewall6-lite.xml @@ -0,0 +1,46 @@ + + + + + shorewall6-lite + + 8 + + Administrative Commands + + + + shorewall6-lite + + Administration tool for Shoreline Firewall 6 Lite + (Shorewall6-lite) + + + + + shorewall6-lite + + | + + -options + + command [ + command-arguments ] + + + + + Description + + The shorewall6-lite utility is used to control the Shoreline + Firewall 6 Lite (Shorewall6-lite). + + Beginning with Shorewall 5.1.0, shorewall6-lite + is a symbolic link pointing to the shorewall(8) executable who + executes the command as if its + and options had been + specified. + + diff --git a/Shorewall6/manpages/shorewall6.xml b/Shorewall6/manpages/shorewall6.xml new file mode 100644 index 000000000..edee8ec49 --- /dev/null +++ b/Shorewall6/manpages/shorewall6.xml @@ -0,0 +1,45 @@ + + + + + shorewall6 + + 8 + + Administrative Commands + + + + shorewall6 + + Administration tool for Shoreline Firewall 6 + (Shorewall6) + + + + + shorewall6 + + | + + -options + + command [ + command-arguments ] + + + + + Description + + The shorewall6 utility is used to control the Shoreline Firewall 6 + (Shorewall6). + + Beginning with Shorewall 5.1.0, shorewall6 is a + symbolic link pointing to the shorewall(8) executable who + executes the command as if its + option had been specified. + +