root/htags/const.h

/* */

INCLUDED FROM

   1 /* This file is generated automatically by convert.pl from htags/manual.in. */
   2 const char *progname = "htags";
   3 const char *usage_const = "Usage: htags [-acDfFghInosTvwx][-d dbpath][-m name][-t title][dir]\n";
   4 const char *help_const = "Options:\n\
   5 -a, --alphabet\n\
   6        Make an alphabetical object index which is suitable for large projects.\n\
   7 --auto-completion[=limit]\n\
   8        Enable auto completion facility for the input form.\n\
   9        If limit is specified, the number of candidates is limited to the value.\n\
  10        Please note that this function requires javascript language in your browser.\n\
  11 --caution\n\
  12        Display a caution message on the top page.\n\
  13 --cflow cflowfile\n\
  14        Add a call tree by cflow(1). cflowfile must be posix format.\n\
  15        If you use GNU cflow, invoke the command at the project root directory\n\
  16        with the --format=posix option.\n\
  17        This option is deprecated. Please use the --call-tree or\n\
  18        --callee-tree instead.\n\
  19 --call-tree callfile\n\
  20        Add a call tree by cflow(1). callfile must be posix format.\n\
  21        If you use GNU cflow, invoke the command at the project root directory\n\
  22        with the --format=posix option.\n\
  23 --callee-tree calleefile\n\
  24        Add a callee tree by cflow(1). calleefile must be posix format.\n\
  25        If you use GNU cflow, invoke the command at the project root directory\n\
  26        with the --format=posix and --reverse option.\n\
  27 -c, --compact\n\
  28        Compress html files by gzip(1).\n\
  29        You need to configure HTTP server so that gzip(1)\n\
  30        is invoked for each compressed file.\n\
  31        See HTML/.htaccess that is generated by htags.\n\
  32 --cvsweb url\n\
  33        Add a link to cvsweb. url is used as the base of URL.\n\
  34        When directory CVS exists in the root directory of the source project,\n\
  35        the content of CVS/Repository is used as the relative path from the base.\n\
  36 --cvsweb-cvsroot cvsroot\n\
  37        Specify cvsroot in cvsweb URL.\n\
  38 -D, --dynamic\n\
  39        Generate object lists dynamically using CGI program.\n\
  40        Though this option decrease both the size and generation time of hypertext,\n\
  41        you need to start up HTTP server.\n\
  42 -d, --dbpath dbpath\n\
  43        Specify a directory in which GTAGS exist.\n\
  44        The default is the current directory.\n\
  45 --disable-grep\n\
  46        Disable grep in the search form(-f,--form).\n\
  47 --disable-idutils\n\
  48        Disable idutils in the search form(-f,--form).\n\
  49 -F, --frame\n\
  50        Use frames for the top page.\n\
  51 -f, --form\n\
  52        Add a search form using CGI program.\n\
  53        You need to start up HTTP server for it.\n\
  54 --fixed-guide\n\
  55        Put a fixed guide at the bottom of the source code.\n\
  56 --full-path\n\
  57        Use full path name in the file index.\n\
  58        By default, use just the last component of a path.\n\
  59 -g, --gtags\n\
  60        Execute gtags(1) before starting job.\n\
  61        The -v, -w and dbpath options are passed to gtags.\n\
  62 --gtagsconf file\n\
  63        Set the GTAGSCONF environment variable to file.\n\
  64 --gtagslabel label\n\
  65        Set the GTAGSLABEL environment variable to label.\n\
  66 -h, --func-header[=position]\n\
  67        Insert function header for each function.\n\
  68        By default, htags doesn't generate it.\n\
  69        You can specify the position using position argument,\n\
  70        which allows one of before, right and after.\n\
  71        The default position is after.\n\
  72 --html-header file\n\
  73        Insert header records derived from file into the HTML header.\n\
  74 -I, --icon\n\
  75        Use icons instead of text for some links.\n\
  76 --insert-footer file\n\
  77        Insert custom footer derived from file before </body> tag.\n\
  78 --insert-header file\n\
  79        Insert custom header derived from file after <body> tag.\n\
  80 --item-order spec\n\
  81        Specify the order of the items in the top page.\n\
  82        The spec is a string consisting of item signs in order.\n\
  83        Each sign means as follows:\n\
  84        c: caution; s: search form;\n\
  85        m: mains; d: definition; f: files; t: call tree.\n\
  86        The default is csmdf.\n\
  87 -m, --main-func name\n\
  88        Specify startup function name. The default is main.\n\
  89 -n, --line-number[=columns]\n\
  90        Print line numbers. By default, doesn't print line numbers.\n\
  91        The default value of columns is 4.\n\
  92 --map-file\n\
  93        Generate files MAP.\n\
  94 -o, --other\n\
  95        Pick up not only source files but also other files in the file index.\n\
  96 --overwrite-key\n\
  97        Allow the same key as the parameter of the --system-cgi option.\n\
  98 --system-cgi key\n\
  99        Use the system CGI script. The key must be a unique key in your site.\n\
 100        At the first time, you should (1) copy the CGI script written by this command\n\
 101        into the system CGI directory, and (2) execute bless.sh script at the HTML directory\n\
 102        as a root user.\n\
 103 -s, --symbol\n\
 104        Make anchors not only for object definitions and references but also other symbols.\n\
 105 --show-position\n\
 106        Show position per function definition. The default is false.\n\
 107 --statistics\n\
 108        Print statistics information.\n\
 109 --suggest\n\
 110        Htags chooses popular options on behalf of beginners.\n\
 111        It is equivalent to '-aghInosTxv --show-position --fixed-guide' now.\n\
 112 --suggest2\n\
 113        Htags chooses popular options on behalf of beginners.\n\
 114        This option enables frame, AJAX and CGI facility in addition\n\
 115        to the facilities by the --suggest option.\n\
 116 -T, --table-flist[=rows]\n\
 117        Use <table> tag to display the file index.\n\
 118        You can optionally specify the number of rows. The default is 5.\n\
 119 -t, --title title\n\
 120        Title of the hypertext.\n\
 121        The default is the last component of the path of the current directory.\n\
 122 --table-list\n\
 123        Use <table> tag to display the tag list.\n\
 124 --tree-view[=type]\n\
 125        Use treeview for the file index.\n\
 126        Please note that this function requires javascript language in your browser.\n\
 127 -v, --verbose\n\
 128        Verbose mode.\n\
 129 -w, --warning\n\
 130        Print warning messages.\n\
 131 -x, --xhtml[=version]\n\
 132        Generate XHTML hypertext. This is the default.\n\
 133        If the --frame option is specified then\n\
 134        generate XHTML-1.0 Frameset for index.html\n\
 135        and generate XHTML-1.0 Transitional for other files,\n\
 136        else if version is 1.1 or config variable\n\
 137        xhtml_version is set to 1.1 then generate\n\
 138        XHTML-1.1 else XHTML 1.0 Transitional.\n\
 139 dir\n\
 140        The directory in which the result of this command is stored.\n\
 141        The default is the current directory.\n\
 142 See also:\n\
 143        GNU GLOBAL web site: http://www.gnu.org/software/global/\n\
 144 ";

/* */