summaryrefslogtreecommitdiffstats
path: root/doc/doxytag.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/doxytag.1')
-rw-r--r--doc/doxytag.120
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/doxytag.1 b/doc/doxytag.1
new file mode 100644
index 0000000..fcaa84b
--- /dev/null
+++ b/doc/doxytag.1
@@ -0,0 +1,20 @@
+.TH DOXYTAG "1" "DATE" "doxytag VERSION" "User Commands"
+.SH NAME
+doxytag \- generates a tag file and/or a search index for a set of HTML files
+.SH SYNOPSIS
+.B doxytag
+[\fI-t tag_file\fR] [\fI-s index_file\fR] [ \fIhtml_file \fR[\fIhtml_file\fR...] ]
+.SH DESCRIPTION
+Generates a tag file and/or a search index for a set of HTML files. Use
+doxysearch as a CGI program to search the tag file generated by doxytag.
+.SH OPTIONS
+.TP
+\fB\-t\fR <tag_file>
+Generate tag file <tag_file>.
+.TP
+\fB\-s\fR <index_file> Generate search index <index_file>.
+.PP
+If no HTML files are given all files in the current dir that
+have a .html extension are parsed.
+.SH SEE ALSO
+doxygen(1), doxywizard(1).