Package: nftables
Version: 1.1.3-1
Severity: minor
Dear nftables maintainers,
I'm migrating my systems from iptables to nftables, utilizing nft
directly instead of compatibility tools. While I appreciate the move to
nftables, I've found the documentation and help output to be
challenging, particularly for new users.
My primary difficulty has been understanding how to view the current
state of the nftables filter. The documentation lacks a clear and
readily accessible method for this, requiring significant effort to
navigate the man page.
Specifically, I've encountered the following issues:
1. The introductory section of the `man nft` page mentions "cmd"
without providing a list of available commands.
2. `nft -h` indicates that commands are optional (`[cmds...]`), but
again, without listing the possible commands.
3. Running `nft` without arguments prompts for a command without
specifying expected input. Similarly, attempts to use guessed
commands like `show` or `list` result in syntax errors with
unhelpful error messages.
It's only after extensive scrolling through the man page that valid
commands like `list` become apparent, buried within the descriptions of
internal concepts such as rules, tables, and chains.
To improve the user experience, I suggest adding a simple example
command to the beginning of the man page and the `--help` output. For
instance:
`nft list [tables|chains|ruleset]`
This would provide a clear starting point for new users attempting to
inspect their existing nftables configuration. I believe this small
addition would significantly benefit many users transitioning to
nftables.
Thank you for considering this suggestion.
