imodqtassist(1)             General Commands Manual            imodqtassist(1)



NAME
       imodqtassist - Displays pages in qch file through Qt Assistant

SYNOPSIS
       imodqtassist  [options]  path_to_help_collection_file

DESCRIPTION
       This program will run Qt Assistant and send it commands to display
       pages in a Qt compressed help (qch) file.  The command line arguments
       indicate where the help collection file is, then an individual page is
       displayed when its name is entered through standard input.

       The path_to_help_collection_file is treated as a path relative to the
       path in the environment variable IMOD_DIR, unless the -a option is
       entered to indicate that the path is absolute.  The option -p must be
       entered along with the name of a Qt help collection (qhc) file to spec-
       ify that Qt Assistant should be started with that .qhc file.  To pro-
       vide legacy behavior, an entry of "IMOD.adp" will be accepted and
       translated into "IMOD.qhc".
        The help collection file is assumed to be relative to the
       path_to_help_collection_file 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, there is no error message, except in Assistant itself.
       If the qhc file is not found, it issues WARNING: qhc file not found.
       If there is actually an error starting Qt Assistant, there will be
       other error messages on the first command to display a page.  In case
       of these errors, the program keeps running.

       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 default prefix
       qthelp://bl3demc/IMOD unless the -q option is entered with a different
       relative or absolute prefix.  If the -b option is entered, then the
       prefix must be a fully qualified one for the qhc file being used; oth-
       erwise, the prefix is simply appended to qthelp://bl3demc/IMOD/.

       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 exit after outputting the
       "Qt ideal thread count", equivalent to the number of processors
       reported by the system, the number of physical cores, the number of
       logical processors, and the value returned by the routine that deter-
       mines the physical memory in the system.

AUTHOR
       David Mastronarde,  mast at colorado dot edu



IMOD                                 5.2.0                     imodqtassist(1)