@@ -6,7 +6,7 @@ begin process to create an RFC_. This tool performs a subset of those actions.
66The actions performed are:
77
88- Validate the file is well formed XML and that it conforms to the XML2RFC Version 3
9- schema as defined in RFC 7991 _ .
9+ schema as defined in ` RFC 7991 `_ .
1010- Verify that embedded XML stanzas are well formed.
1111- Verify that embedded ABNF is complete and well formed.
1212- Identify misspelled words.
@@ -17,3 +17,116 @@ The tool can be used either in an interactive mode or in batch mode.
1717.. _Internet-Draft : https://en.wikipedia.org/wiki/Internet_Draft
1818.. _RFC : https://en.wikipedia.org/wiki/Request_for_Comments
1919.. _RFC 7991 : https://tools.ietf.org/html/rfc7991
20+
21+ Usage
22+ =====
23+
24+ rfclint accepts a single XML document as input and optionally outputs a modified version
25+ of the document.
26+
27+ **Basic Usage **: ``rfclint [options] SOURCE ``
28+
29+
30+ **General Options **
31+
32+ General options for the program
33+
34+ ================ ========================= ==================================================
35+ Short Long Description
36+ ================ ========================= ==================================================
37+ ``-C `` ``--clear-cache `` purge the cache and exit
38+ ``-N `` ``--no-network `` don't use the network to resolve references
39+ ``-n `` ``--no-rng `` don't check against the RNG schema
40+ ``-q `` ``--quiet `` don't print anything
41+ ``--save-config `` save configuration back to config file
42+ ``-v `` ``--verbose `` print extra information
43+ ``-V `` ``--version `` display the version number and exit
44+ ``-X `` ``--no-xinclude `` don't resolve xi:include elements
45+
46+ ``-c DIRECTORY`` ``--cache=DIRECTORY`` specify the primary cache directory to write to
47+ ``--configfile=FILENAME `` specify the configuration file to use
48+ ``-o FILENAME `` ``--out=FILENAME `` specify an output filename
49+ ``-r RNG `` ``--rng=RNG `` specify an alternate RNG file
50+ ``--extract=TYPE `` extract all source code for the given type
51+ ================ ========================= ==================================================
52+
53+
54+
55+ **Spelling Options **
56+
57+ The following options affect how the spell checking is performed.
58+
59+ =============== ======================= ==================================================
60+ Short Long Description
61+ =============== ======================= ==================================================
62+ ``--no-dup-detection `` don't perform duplicate detection
63+ ``--no-spell `` don't perform spell checking on the source
64+ ``--no-suggest `` don't provide suggestions for misspelled words
65+ ``--no-spell `` provide suggestions for misspelled words (default)
66+
67+ ``--color=TEXT`` specify the color to use for word highlighting
68+ ``--dictionary=FILENAME `` specify an additional dictionary to use
69+ ``--personal=FILENAME `` specify the personal dictionary to use
70+ ``--spell-program=FILENAME `` program to use for spell checking
71+ ``--spell-window=NUM `` how many words to display as part of the context
72+ =============== ======================= ==================================================
73+
74+ It is assumed that the spell checking program is aspell and that aspell is on the path.
75+ For Windows systems, it additionally look in "C:\P rogram Files (x86)\A spell\b in" for the program.
76+ If a different program is given, then it should be either an absolute path or on the path so that
77+ it can be located.
78+
79+ When a misspelled word is located, a certain amount of context will be provided along with the file
80+ and line number of the word. The spell-window parameter controls how many words are displayed with
81+ up to that number of words being displayed before and after the misspelled word. The context window
82+ is also restricted to the current paragraph. The color option allows for the misspelled word to
83+ be highlighted, but it requires VT100 terminal emulation and thus may not always work well on Windows
84+ systems. The color defaults to 'bright' on non-Windows systems and 'none' on Windows systems.
85+ If the value of spell-window is 0, then no context will be displayed.
86+
87+ **ABNF Checking Options **
88+
89+ =============== ======================= ==================================================
90+ Short Long Description
91+ =============== ======================= ==================================================
92+ ``--no-abnf `` don't perform abnf checking on the source
93+
94+ ``--abnf-add-rules`` ABNF file to include when checking
95+ ``--abnf-program=FILENAME `` specify program to use for ABNF checking
96+ =============== ======================= ==================================================
97+
98+ Configuration File
99+ ==================
100+
101+ rfclint keeps configuration information in a configuration file. By default the file is stored at
102+
103+ * On Windows: c:\U sers\U SER\A ppDatea\L ocal\r fclint\I ETF\r fclint.cfg
104+ * Otherwise: /home/USER/.local/share/rfclint/rfclint.cfg
105+
106+ The format of the configuration file is the standard INI file format.
107+
108+ **Spell Configuration **
109+
110+ * program - name of the spelling program to use - defaults to aspell
111+ * window - number of words to display on each side of a misspelled word
112+ * color - color to use to highlight the misspelled word
113+ * suggest - Should suggested values be displayed? value is 0 or 1
114+ * dictionaries - a comma separated list of dictionaries to include
115+
116+ **ABNF Configuration **
117+
118+ * program - name of the ABNF program to use - defaults to bap provided w/ rfclint
119+ * addRules - name of file to be processed along with rules in the source
120+
121+ Dependencies
122+ ============
123+
124+ rfclint depends on the following packages:
125+
126+ * lxml _ *(>= 4.1.1) *
127+ * requests _ *(>= 2.5.0) *
128+ * `rfctools_common `_ *(>= 0.1.0) *
129+
130+ .. _lxml : http://lxml.de
131+ .. _requests : http://docs.python-requests.org
132+ .. _rfctools_common : https://pypi.python.org/pypi/pip
0 commit comments