The quhelp program can be executed as-is without arguments or with one or more of the following arguments:
Argument | Value | Default | Usage |
‑c content | an existing directory | content | Specify a directory to be scanned for the help site's content. |
‑T template | an existing directory | template | Specify a directory to be used as the source for the site's template. |
‑o name | a directory name | output | Specify a name for the directory where the help site files will be created. If the directory does not exist, it will be created. |
‑t title | a title | Online Help | Specify a different title for the help site. Note that the program expects this as a single argument, so in some shells you must enclose the title in quotes. Most UNIX shells support the -t "foo bar" form which passes foo bar as a single string to the program. Consult your shell's documentation about this if you are not using a UNIX shell. |
‑C condition | a single condition | none | Specify one or more conditions (more than one conditions are specified with more -C arguments). Conditions are checked against the @condition directive in pages and pages are included only if they match. |
‑S | none | none | In addition to the normal site, create a "solid" (single page) version of the help site. This can be used to create printable or text-only (via an external html-to-plain-text converter) versions of the help site. Using this will also disable all links that begin with <a href. Note that any referenced file, such as image files, is not preserved. For printable versions, the images must be manually copied. For text-only conversions, it doesn't make much sense anyway. |
quhelp -o help -c helpsrc -t "Foobaz Help" -T uber_template
This will create a help site in the help directory with the uber_template template and with content from the helpsrc directory. The title of the help site will be Foobaz help.
Note: since version 0.4, the template can be placed either inside the current directory (the directory from where quhelp is called), or in a system-wide directory. The system-wide directory's path depends on the operating system: under Windows it is the same directory as the directory containing the quhelp.exe executable and under other systems it is a directory path defined at compile time which by default is set to /usr/local/share/quhelp.