pikth

pikth is the PIKT online help utility. It takes the following command-line arguments:

Usage:  pikth [options] [-i value]

      Options:
        -i               search for error code 'value' (text or ID)
        -V               show version info
        -G               debug mode
        -h               help

Suppose, for example, you run piktc and get the following error:

Oct 14 09:07:18 vienna piktc[20916]: [ID 1101 ERROR]
  (../../../src/piktc/bitset.c, line 223, getbs())
  /pikt/lib/configs/macros.cfg, at or near line 489:
  define strict unknown

You could get additional explanation by using pikth with the indicated numerical error id:

# pikth -i 1101                

Error #1101 (ERRID_DEFINE_UNKNOWN)

   The referenced logical define is unknown (does not appear to be
   registered in your defines.cfg file).
   This is always a fatal error.
   Please
   --change the reference (by fixing a misspelling maybe)
   --remove the reference (remove the #ifdef stanza)
   --or add the referenced logical define to your defines.cfg file
   --refer to the defines.cfg section of the Reference for further
     explanation

pikth gives an extended explanation for the error, suggests possible causes and fixes, and directs you to the appropriate place(s) in the documentation for further reference.

You would see the same the same explanation if instead you were to specify the named error id:

# pikth -i ERRID_DEFINE_UNKNOWN

Error #1101 (ERRID_DEFINE_UNKNOWN)

   The referenced logical define is unknown (does not appear to be
   registered in your defines.cfg file).
   ...

pikth is a continual work-in-progress. Eventually, the design goal is for pikth to point you to a solution for 99%+ of your PIKT problems. (Note that pikth provides on-line help for the PIKT C binaries only--piktc, piktc_svc, pikt, piktd, and pikts--and not for the Perl utilities--piktx, piktf, rkey, and pikth itself.)

Unlike many of the other PIKT binaries (which are written using a combination of C, lex, and yacc), pikth (like piktf, piktx & rkey) is written in Perl.

1st page