i-nex / I-Nex

System information tool written in gambas3, python, bash
http://i-nex.linux.pl/
174 stars 24 forks source link

need to add one more manpage i-nex-dimms #44

Closed shirishag75 closed 7 years ago

shirishag75 commented 7 years ago

Lintian gives me the below -

W: i-nex: binary-without-manpage usr/bin/i-nex-dimms
N: 
N:    Each binary in /usr/bin, /usr/sbin, /bin, /sbin or /usr/games should
N:    have a manual page
N:    
N:    Note that though the man program has the capability to check for several
N:    program names in the NAMES section, each of these programs should have
N:    its own manual page (a symbolic link to the appropriate manual page is
N:    sufficient) because other manual page viewers such as xman or tkman
N:    don't support this.
N:    
N:    If the name of the man page differs from the binary by case, man may be
N:    able to find it anyway; however, it is still best practice to make the
N:    case of the man page match the case of the binary.
N:    
N:    If the man pages are provided by another package on which this package
N:    depends, lintian may not be able to determine that man pages are
N:    available. In this case, after confirming that all binaries do have man
N:    pages after this package and its dependencies are installed, please add
N:    a lintian override.
N:    
N:    Refer to Debian Policy Manual section 12.1 (Manual pages) for details.
N:    
N:    Severity: normal, Certainty: possible
N:    
N:    Check: manpages, Type: binary
N: 

I see -

┌─[shirish@debian] - [~/games] - [10090]
└─[$] i-nex-dimms --help                                                                                                          
Usage: /usr/bin/i-nex-dimms [-c] [-f [-b]] [-x|-X file [files..]]
       /usr/bin/i-nex-dimms -h

  -f, --format            Print nice html output
  -b, --bodyonly          Don't print html header
                          (useful for postprocessing the output)
      --side-by-side      Display all DIMMs side-by-side if possible
      --merge-cells       Merge neighbour cells with identical values
                          (side-by-side output only)
  -c, --checksum          Decode completely even if checksum fails
  -x,                     Read data from hexdump files
  -X,                     Same as -x except treat multibyte hex
                          data as little endian
  -h, --help              Display this usage summary

Hexdumps can be the output from hexdump, hexdump -C, i2cdump, eeprog and
likely many other progams producing hex dumps of one kind or another.  Note
that the default output of "hexdump" will be byte-swapped on little-endian
systems and you must use -X instead of -x, otherwise the dump will not be
parsed correctly.  It is better to use "hexdump -C", which is not ambiguous.

Simply just have a manpage with the same content as what --help invokes. If you want to make more documentation in the manpage, it is of course welcome. Something similar to what you have done in e0d7d2e