Crate doc_writer[−][src]
Expand description
Generate documentation in multiple formats using the DocumentationWriter
trait.
Implementations of which can be found in the render
module for man pages and Markdown files.
Generated contents look like this:
grep.md
grep – print lines that match patterns
usage: grep [OPTION...] PATTERNS [FILE...]
grep searches for PATTERNS in each FILE. PATTERNS is one or more patterns separated by newline characters.
A FILE of “-” stands for standard input.
Options
--help
: Output a usage message and exit.--color=auto
: Display color on the terminal
Regular Expressions
A regular expression is a pattern that describes a set of strings.
Perl-compatible regular expressions give additional functionality, and are documented in pcresyntax(3)
Environment
GREP_COLOR=auto
: Display color on the terminal
License
Copyright 1998-2000, 2002, 2005-2020 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
man grep.1
GREP(1) General Commands Manual GREP(1) NAME grep — print lines that match patterns SYNOPSIS grep [OPTION...] PATTERNS [FILE...] DESCRIPTION grep searches for PATTERNS in each FILE. PATTERNS is one or more patterns sepa‐ rated by newline characters. A FILE of “-” stands for standard input. OPTIONS --help Output a usage message and exit. --color=auto Display color on the terminal REGULAR EXPRESSIONS A regular expression is a pattern that describes a set of strings. Perl-compatible regular expressions give additional functionality, and are docu‐ mented in pcresyntax(3) ENVIRONMENT GREP_COLOR=auto Display color on the terminal SEE ALSO pcresyntax(3) COPYRIGHT Copyright 1998-2000, 2002, 2005-2020 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐ POSE. GREP(1)
Modules
Implementations of DocumentationWriter
for different file formats.
Enums
parse-markdown
Error wraps errors during markdown processing by MarkdownParseExt::write_markdown
and io errors occurring during writing.
Traits
A way to format documentation.
parse-markdown
Contributes the write_markdown
function to DocumentationWriter
s.