Bug 1717878

Summary: iptables-save refers to missing manpage
Product: Red Hat Enterprise Linux 8 Reporter: Tomas Dolezal <todoleza>
Component: iptablesAssignee: Phil Sutter <psutter>
Status: CLOSED ERRATA QA Contact: Jiri Peska <jpeska>
Severity: low Docs Contact:
Priority: medium    
Version: 8.1CC: iptables-maint-list, jpeska, todoleza
Target Milestone: rcKeywords: Documentation
Target Release: 8.1   
Hardware: Unspecified   
OS: Linux   
Whiteboard:
Fixed In Version: iptables-1.8.2-12.el8 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-11-05 22:17:45 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Tomas Dolezal 2019-06-06 11:43:11 UTC 
Description of problem:
1)
iptables-save --help/unknown parameter to iptables-save causes error message with reference to  missing manpage / manpage of other name.

2)
iptables-restore refers to xtables-restore, which is also not present on system


Version-Release number of selected component (if applicable):
iptables-1.8.2-11.el8.x86_64

How reproducible:
always

Steps to Reproduce:
1)
# iptables-save --help
iptables-save: unrecognized option '--help'
Look at manual page `xtables-save.8' for more information.

2)
2nd related issue:
# iptables-restore --bad
iptables-restore: unrecognized option '--bad'
Try `xtables-restore -h' for more information.


Actual results:
* manpage is missing, however iptables-save and iptables-restore pages are provided
* xtables-restore is absent

Expected results:
* manpage symlink / corrected error message
* iptables-restore message should also be corrected to refer to available command

Additional info:
rpm -qd iptables
/usr/share/doc/iptables/INCOMPATIBILITIES
/usr/share/man/man8/ip6tables-restore.8.gz
/usr/share/man/man8/ip6tables-save.8.gz
/usr/share/man/man8/ip6tables.8.gz
/usr/share/man/man8/iptables-apply.8.gz
/usr/share/man/man8/iptables-extensions.8.gz
/usr/share/man/man8/iptables-restore.8.gz
/usr/share/man/man8/iptables-save.8.gz
/usr/share/man/man8/iptables.8.gz
/usr/share/man/man8/nfnl_osf.8.gz
/usr/share/man/man8/xtables-monitor.8.gz
/usr/share/man/man8/xtables-nft.8.gz
/usr/share/man/man8/xtables-translate.8.gz
Comment 2 Phil Sutter 2019-06-08 18:02:21 UTC 
Fix for iptables-save:

commit 934479aa1f1576afba97b137a101a60d8534370c
Author: Phil Sutter <phil>
Date:   Wed Mar 13 20:46:17 2019 +0100

    xtables-save: Point at existing man page in help text
    
    Signed-off-by: Phil Sutter <phil>
    Signed-off-by: Florian Westphal <fw>


A fix for iptables-restore has been sent upstream: https://marc.info/?l=netfilter-devel&m=156001526722299&w=2
Comment 3 Phil Sutter 2019-06-12 17:45:36 UTC 
Z-stream request must be a mistake, 8.1 isn't even released yet.

Patch has been accepted, second commit to backport on behalf of this bug:

commit ac531b4681d1a0309a738d7bc3408fc2270eaa03
Author: Phil Sutter <phil>
Date:   Sat Jun 8 19:34:13 2019 +0200

    xtables-restore: Fix program names in help texts
    
    Avoid referring to wrong or even non-existent commands:
    
    * When calling xtables_restore_main(), pass the actual program name
      taken from argv[0].
    * Use 'prog_name' in unknown parameter and help output instead of
      'xtables-restore' which probably doesn't exist.
    * While being at it, fix false whitespace in help text.
    
    Signed-off-by: Phil Sutter <phil>
    Signed-off-by: Pablo Neira Ayuso <pablo>
Comment 7 errata-xmlrpc 2019-11-05 22:17:45 UTC 
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2019:3573