Real world the help

9) Accessing Help for Commands and Examples

There are many ways to invoke the help feature of zpaqfranz and view its examples.

Using the Help Command

• General Help:

  • To see the list of commands, you can simply type:

    zpaqfranz h h
    

  • This will display an overview of commands like 1on1, a, autotest, b, backup, c, etc.

• Help for Specific Commands:

  • If you want help specifically for the command a, you would write:

    zpaqfranz h a
    

  • This will show a wealth of switches, brief descriptions, and especially examples detailing (almost) all functionalities of zpaqfranz.

Importance of Integrated Help

• The integrated help, accessed via the h command, is invaluable for understanding exactly what to do and how to operate with zpaqfranz.

Example Scenario

• Disabling Recursive Loading:
  • Suppose you want to disable recursive loading of data from within a folder. If the folder c:\dati contains subfolders that you do not want to include, how do you achieve that?
  • Simply type:

    zpaqfranz h a
    

  • Look for a switch and example that meets your needs (spoiler: the switch is -norecursion).

More details