Incorrect --help / manpage for -color for ip, tc, bridge

Incorrect --help / manpage for -color for ip, tc, bridge

[Witold Baryluk]

iproute 5.9.0

Apparently ip -c is a shortcut to ip -color

but in tc, tc -c doesn't work, one needs to say tc -col or tc -color

I understand there is tc -conf, which has tc -c.

But:

Help says:

root@debian:~# tc
Usage:    tc [ OPTIONS ] OBJECT { COMMAND | help }
    tc [-force] -batch filename
where  OBJECT := { qdisc | class | filter | chain |
            action | monitor | exec }
       OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] | -r[aw] |
            -o[neline] | -j[son] | -p[retty] | -c[olor]
            -b[atch] [filename] | -n[etns] name | -N[umeric] |
             -nm | -nam[es] | { -cf | -conf } path }

this should be:

root@debian:~# tc
Usage:    tc [ OPTIONS ] OBJECT { COMMAND | help }
    tc [-force] -batch filename
where  OBJECT := { qdisc | class | filter | chain |
            action | monitor | exec }
       OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] | -r[aw] |
            -o[neline] | -j[son] | -p[retty] | -col[or]
            -b[atch] [filename] | -n[etns] name | -N[umeric] |
             -nm | -nam[es] | { -cf | -c[onf] } path }


( -c[olor] -> -col[or] )  # also in --help for ip and bridge

If only -c meaning -conf could be removed, it would be even nicer. -cf
is already short.

Additionally in manpage for tc, ip and bridge:
       -c[color][={always|auto|never}
              Configure color output. If parameter is omitted or
always, color output is enabled regardless of stdout state. If
parameter is auto, stdout is checked to be a terminal be‐
              fore  enabling  color output. If parameter is never,
color output is disabled. If specified multiple times, the last one
takes precedence. This flag is ignored if -json is
              also given.



I don't think this is correct either.

Should be -col[or], not -c[color] (sic!).

Similar mistakes are in man pages and --help messages also for ip,
bridge, not just tc.


Regards,
Witold

Re: Incorrect --help / manpage for -color for ip, tc, bridge

[Stephen Hemminger]

On Sat, 12 Dec 2020 20:07:16 +0000
Witold Baryluk <witold.baryluk@gmail.com> wrote:

> iproute 5.9.0
> 
> Apparently ip -c is a shortcut to ip -color
> 
> but in tc, tc -c doesn't work, one needs to say tc -col or tc -color
> 
> I understand there is tc -conf, which has tc -c.
> 
> But:
> 
> Help says:
> 
> root@debian:~# tc
> Usage:    tc [ OPTIONS ] OBJECT { COMMAND | help }
>     tc [-force] -batch filename
> where  OBJECT := { qdisc | class | filter | chain |
>             action | monitor | exec }
>        OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] | -r[aw] |
>             -o[neline] | -j[son] | -p[retty] | -c[olor]
>             -b[atch] [filename] | -n[etns] name | -N[umeric] |
>              -nm | -nam[es] | { -cf | -conf } path }
> 
> this should be:
> 
> root@debian:~# tc
> Usage:    tc [ OPTIONS ] OBJECT { COMMAND | help }
>     tc [-force] -batch filename
> where  OBJECT := { qdisc | class | filter | chain |
>             action | monitor | exec }
>        OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] | -r[aw] |
>             -o[neline] | -j[son] | -p[retty] | -col[or]
>             -b[atch] [filename] | -n[etns] name | -N[umeric] |
>              -nm | -nam[es] | { -cf | -c[onf] } path }
> 
> 
> ( -c[olor] -> -col[or] )  # also in --help for ip and bridge
> 
> If only -c meaning -conf could be removed, it would be even nicer. -cf
> is already short.
> 
> Additionally in manpage for tc, ip and bridge:
>        -c[color][={always|auto|never}
>               Configure color output. If parameter is omitted or
> always, color output is enabled regardless of stdout state. If
> parameter is auto, stdout is checked to be a terminal be‐
>               fore  enabling  color output. If parameter is never,
> color output is disabled. If specified multiple times, the last one
> takes precedence. This flag is ignored if -json is
>               also given.
> 
> 
> 
> I don't think this is correct either.
> 
> Should be -col[or], not -c[color] (sic!).
> 
> Similar mistakes are in man pages and --help messages also for ip,
> bridge, not just tc.
> 
> 
> Regards,
> Witold

Send a patch to fix it.