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