.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH RUSTDOC-STRIPPER "1" "December 2018" "rustdoc-stripper 0.1.5" "User Commands"
.SH NAME
rustdoc-stripper \- rustdoc-stripper
.SH DESCRIPTION
.SS "Available options for rustdoc-stripper:"
.TP
\fB\-h\fR | \fB\-\-help\fR
: Displays this help
.TP
\fB\-s\fR | \fB\-\-strip\fR
: Strips the specified folder's files and create
a file with doc comments (comments.md by default)
.TP
\fB\-g\fR | \fB\-\-regenerate\fR
: Recreate files with doc comments from reading
doc comments file (comments.md by default)
.TP
\fB\-n\fR | \fB\-\-no\-file\-output\fR
: Display doc comments directly on stdout
.TP
\fB\-i\fR | \fB\-\-ignore\fR [filename]
: Ignore the specified file, can be repeated as much
as needed, only used when stripping files, ignored
otherwise
.TP
\fB\-d\fR | \fB\-\-dir\fR [directory]
: Specify a directory path to work on, optional
.TP
\fB\-v\fR | \fB\-\-verbose\fR
: Activate verbose mode
.TP
\fB\-f\fR | \fB\-\-force\fR
: Remove confirmation demands
.TP
\fB\-m\fR | \fB\-\-ignore\-macros\fR
: Macros in hierarchy will be ignored (so only macros
with doc comments will appear in the comments file)
.TP
\fB\-o\fR | \fB\-\-comment\-file\fR
: Specify the file where you want to save/load doc
comments
.TP
\fB\-x\fR | \fB\-\-ignore\-doc\-commented\fR: When regenerating doc comments, if doc comments
are already present, stored doc comment won't be
regenerated
.PP
By default, rustdoc\-stripper is run with \fB\-s\fR option:
\&./rustdoc\-stripper \fB\-s\fR
.PP
IMPORTANT: Only files ending with '.rs' will be stripped/regenerated.