[Pkg-samba-maint] Bug#1022945: smbclient: ambiguous duplications in the smbclient(1) manpage

[Patrice DUROUX]

Package: smbclient
Version: 2:4.16.6+dfsg-5
Severity: wishlist

Dear Maintainer,

The smbclient(1) manpage contains some multiple entries in the OPTIONS
section regarding the SYNOPSIS list.

Here are the two detected cases:

71:       -m|--max-protocol protocol
72-           This allows the user to select the highest SMB protocol level that smbclient will use to connect to the server. By default this is set to highest available SMB3
and
259:       -m|--max-protocol=MAXPROTOCOL
260-           The value of the parameter (a string) is the highest protocol level that will be supported by the client.

76:       -P|--machine-pass
77-           Make queries to the external server using the machine account of the local server.
and
335:       -P|--machine-pass
336-           Use stored machine account password.

Moreover the entries in the OPTIONS section should be more consistent to the SYNOPSIS
syntax. For instance, SYNOPSIS is:

       smbclient [-M|--message=HOST] [-I|--ip-address=IP] [-E|--stderr] [-L|--list=HOST] [-T|--tar=<c|x>IXFvgbNan] [-D|--directory=DIR] [-b|--send-buffer=BYTES]
        [-t|--timeout=SECONDS] [-p|--port=PORT] [-g|--grepable] [-q|--quiet] [-B|--browse] [-?|--help] [--usage] [-d|--debuglevel=DEBUGLEVEL] [--debug-stdout]
        [-s|--configfile=CONFIGFILE] [--option=name=value] [-l|--log-basename=LOGFILEBASE] [--leak-report] [--leak-report-full] [-R|--name-resolve=NAME-RESOLVE-ORDER]
        [-O|--socket-options=SOCKETOPTIONS] [-m|--max-protocol=MAXPROTOCOL] [-n|--netbiosname=NETBIOSNAME] [--netbios-scope=SCOPE] [-W|--workgroup=WORKGROUP]
        [--realm=REALM] [-U|--user=[DOMAIN/]USERNAME%[PASSWORD]] [-N|--no-pass] [--password=STRING] [--pw-nt-hash] [-A|--authentication-file=FILE] [-P|--machine-pass]
        [--simple-bind-dn=DN] [--use-kerberos=desired|required|off] [--use-krb5-ccache=CCACHE] [--use-winbind-ccache] [--client-protection=sign|encrypt|off] [-V|--version]
        [-c|--command=STRING]

and the entries in OPTIONS are (with the duplicates):
       -M|--message NetBIOS name      <- =HOST
       -p|--port port                 <- =PORT
       -g|--grepable
       -m|--max-protocol protocol     <- duplicated
       -P|--machine-pass              <- duplicated
       -I|--ip-address IP-address     <- =IP
       -E|--stderr
       -L|--list                      <- =HOST
       -b|--send-buffer buffersize    <- =BYTES
       -B|--browse
       -t|--timeout <timeout-seconds> <- =SECONDS
       -T|--tar tar options           <- =<c|x>IXFvgbNan
       -D|--directory initial directory <- =DIR
       -c|--command command string    <- =STRING
       -?|--help
       -d|--debuglevel=DEBUGLEVEL
       -l|--log-basename=logdirectory <- =LOGFILEBASE
       -V|--version
       -R|--name-resolve=NAME-RESOLVE-ORDER
       -O|--socket-options=SOCKETOPTIONS
       -m|--max-protocol=MAXPROTOCOL
       -n|--netbiosname=NETBIOSNAME
       -W|--workgroup=WORKGROUP
       -r|--realm=REALM
       -U|--user=[DOMAIN\]USERNAME[%PASSWORD] <- / or \ ?
       -N|--no-pass
       -A|--authentication-file=filename
       -P|--machine-pass

And as we can see, the SYNOPSIS set is much larger than that of OPTIONS.

Regards,
Patrice

ps: I just used the following command to check: man smbclient | grep -n -A 1 '\-.|' 

-- System Information:
Debian Release: bookworm/sid
  APT prefers unstable
  APT policy: (500, 'unstable')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 5.17.0-2-amd64 (SMP w/24 CPU threads; PREEMPT)
Kernel taint flags: TAINT_FIRMWARE_WORKAROUND
Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (charmap=UTF-8), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

Versions of packages smbclient depends on:
ii  libarchive13  3.6.0-1
ii  libbsd0       0.11.7-1
ii  libc6         2.35-4
ii  libgnutls30   3.7.8-2
ii  libpopt0      1.19+dfsg-1
ii  libreadline8  8.2-1
ii  libsmbclient  2:4.16.6+dfsg-5
ii  libtalloc2    2.3.4-1
ii  libtevent0    0.13.0-1
ii  samba-common  2:4.16.6+dfsg-5
ii  samba-libs    2:4.16.6+dfsg-5

smbclient recommends no packages.

Versions of packages smbclient suggests:
ii  cifs-utils       2:7.0-2
pn  heimdal-clients  <none>

-- no debconf information