.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` . ds C' 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "HELPZTAGS 1" .TH HELPZTAGS 1 "August 2010" "vim 9.1" "User Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME helpztags \- generate the help tags file for directory .SH SYNOPSIS .IX Header "SYNOPSIS" helpztags \fIDIRS\fR... .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fIhelpztags\fR scans given directories for \fI*.txt\fR and \fI*.txt.gz\fR files. Each file is scanned for tags used in \fIvim\fR help files. For each directory proper \fItags\fR file is generated. .PP There should be at least one directory given. In other case program exits with error. .SH AUTHORS .IX Header "AUTHORS" Written by Jakub Turski and Artur R. Czechowski based on idea contained in \f(CW\*(C`vim\*(C'\fR sources for its \f(CW\*(C`:helptags command\*(C'\fR. .SH "REPORTING BUGS" .IX Header "REPORTING BUGS" Please use a Debian \f(CW\*(C`reportbug\*(C'\fR command or procedure described at \&\f(CW\*(C`http://bugs.debian.org/\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" Read \f(CW\*(C`:help helptags\*(C'\fR in \fIvim\fR for detailed information about helptags.