JustinTimperio / pacback

Advanced Version Control for Arch Linux
MIT License
148 stars 4 forks source link

Help -h page formatting make it difficult to read #37

Open Cody-Learner opened 1 year ago

Cody-Learner commented 1 year ago

I have yet to try pacbac, but after filing this, planning on a deep dive with it in a virtual install. However, I got hung up trying to figure out how to use it using the help page, and noticed there's no man page. The help page formatting in my vt shell (bash) made it very difficult to comprehend. The line length ran beyond the max vt width I had and continued on the next line, into the options column. I'd think there has to be some standards on formatting for Linux help and man pages, although I've not looked into this myself.

That said, I did find the github user guide easy to read and informative.

I reformatted, made a few edits to the help page for my personal notes. I've inserted my notes for some ideas on how the formatting may possibly be improved.

I also noticed it's been a few years since any activity. Are you still maintaining/updating pacbac?

usage: pacback  [-h] [-c 1] [--hook] [-rp 1] [-ss 1] [-pkg [pkg_name ...]] 
        [-dt 2020/06/23] [-f] [-d [/path/here ...]] [-nc] [-l Label Name] [-ih] [-rh]
        [-cl] [-rm 2] [-v] [-i 1] [-df 1 2 1 2] [-ls] [-cache]

options:

 -h     --help                          Show this help message and exit
 -c     --create_rp     <number>        Generate a pacback restore point.
        --hook                          Used by pacback hook to create snapshots.
 -rp    --restore_point <number>        Rollback to a restore point.
 -ss    --snapshot      <number>        Rollback to a snapshot.
 -pkg   --package       <pkg-names>     Rollback a list of packages.
 -dt    --date          <yyyy/mm/dd>    Rollback to a date in the ALA, Arch Linux Archive.
 -f     --full_rp                       Create full restore point.
 -d     --add_dir       </file/path/>   Add custom directories to your restore point when using `--full_rp`.
 -nc    --no_confirm                    Skip asking user questions. Will typically answer yes to all.
 -l     --label         <label-name>    Tag your restore point with a label.
 -ih    --install_hook                  Install a pacman hook that creates snapshots.
 -rh    --remove_hook                   Remove the pacman hook that creates snapshots.
 -cl    --clean                         Clean old packages, orphaned packages, and old restore points.
 -rm    --remove        <number>        Removes the selected restore point.
 -v     --version                       Display pacback version and cache info.
 -i     --info 1                        Print information about a restore point.
 -df    --diff          <ss rp>         Compare any two restore points or snapshots.
 -ls    --list                          List information about all existing restore points and snapshots.
 -cache --cache_size                    Calculate reported and actual cache sizes.
 -df    --diff          <ss rp>         Compare any two restore points or snapshots.

                                        Note: <ss> = snapshots,  <rp> = restore points.

 User guide with examples:              https://github.com/JustinTimperio/pacback/blob/master/USER_GUIDE.md