imodqtassist(1)                                                imodqtassist(1)



NAME
       imodqtassist - Displays html pages through Qt Assistant

SYNOPSIS
       imodqtassist [-a | -p adp_file| -k] document_path

DESCRIPTION
       This program will run Qt Assistant and send it commands to display html
       documents.  The command line arguments indicate where the documents
       are, then an individual page is displayed when its name is entered
       through standard input.

       The document_path is treated as a path relative to the path in the
       environment variable IMOD_DIR, unless the -a option is entered to indi-
       cate that the path is absolute.  If the option -p is entered along with
       adp_file, the name of an Assistant Document Profile file, then Qt
       Assistant will be started with that .adp file.  The adp_file is assumed
       to be relative to the document_path unless it is itself an absolute
       file path specification.

       When a line is entered through standard input, the program attempts to
       display the page.  If it succeeds, it prints Page xxx displayed to
       standard error and continues waiting for more input.  If it fails to
       find the page, it prints Page xxx not found to standard error and also
       keeps running.  If the adp_file is not found, it issues WARNING: adp
       file not found in addition to the message with regard to the page, but
       only on the first request for a page.  If there is actually an error
       starting Qt Assistant, the program will exit with a non-zero exit sta-
       tus.  This will not happen until the first command to display a page.

       Enter a line with just a "q" to terminate the program and close the
       current Qt Assistant if one is open.

       Each page file entry is assumed to be relative to the document_path
       unless it is itself an absolute file path specification.  There is some
       redundancy here if absolute paths are used, since if both the adp_file
       and the individual pages are entered with absolute paths, the docu-
       ment_path becomes irrelevant.

       By default, the Assistant sidebar will be started with an argument to
       hide the sidebar.  Use the -k option to omit this argument and keep the
       sidebar open if the user had opened it.

       A completely unrelated behavior is available by running the program
       with "imodqtassist -t".  In this case it will output the "Ideal thread
       count", equivalent to the number of processors reported by the system,
       and exit.

AUTHOR
       David Mastronarde,  mast at colorado dot edu



BL3DEMC                              4.3.7                     imodqtassist(1)