Package: rfclint
Perform Validation checks on Internet-DraftsThere are a number of tasks that need to be performed when anInternet-Draftis
begin process to create anRFC. This tool performs a subset of those actions.
The actions performed are:Validate the file is well formed XML and that it conforms to the XML2RFC Version 3
schema as defined inRFC 7991.Verify that embedded XML stanzas are well formed.Verify that embedded ABNF is complete and well formed.Identify misspelled words.Detect duplicate words.The tool can be used either in an interactive mode or in batch mode.Usagerfclint accepts a single XML document as input and optionally outputs a modified version
of the document.Basic Usage:rfclint [options] SOURCEGeneral OptionsGeneral options for the programShortLongDescription-C--clear-cachepurge the cache and exit-N--no-networkdon’t use the network to resolve references-n--no-rngdon’t check against the RNG schema-q--quietdon’t print anything.--save-configsave configuration back to config file-v--verboseprint extra information-V--versiondisplay the version number and exit-X--no-xincludedon’t resolve xi:include elements.--no-xmldon’t check xml examples for well-formness.--bcp14do checking for bcp14 keywords.--no-svgcheckskip check svg for limited vocabulary-cDIRECTORY--cache=DIRECTORYspecify the primary cache directory to write to.--configfile=FILENAMEspecify the configuration file to use-oFILENAME--out=FILENAMEspecify an output filename-rRNG--rng=RNGspecify an alternate RNG file.--extract=TYPEextract all source code for the given typeSpelling OptionsThe following options affect how the spell checking is performed.ShortLongDescription.--no-dup-detectiondon’t perform duplicate detection.--no-spelldon’t perform spell checking on the source.--no-suggestdon’t provide suggestions for misspelled words.--skip-codeskip code elements when checking.--skip-artworkskip artwork elements check checking.--no-cursesdon’t do window based.--color=TEXTspecify the color to use for word highlighting.--dictionary=FILENAMEspecify an additional dictionary to use.--personal=FILENAMEspecify the personal dictionary to use.--spell-program=FILENAMEprogram to use for spell checking.--spell-window=NUMhow many words to display as part of the contextIt is assumed that the spell checking program is aspell and that aspell is on the path.
For Windows systems, it additionally look in “C:\Program Files (x86)\Aspell\bin” for the program.
If a different program is given, then it should be either an absolute path or on the path so that
it can be located.When a misspelled word is located, a certain amount of context will be provided along with the file
and line number of the word.  The spell-window parameter controls how many words are displayed with
up to that number of words being displayed before and after the misspelled word.  The context window
is also restricted to the current paragraph.  The color option allows for the misspelled word to
be highlighted, but it requires VT100 terminal emulation and thus may not always work well on Windows
systems.  The color defaults to ‘bright’ on non-Windows systems and ‘none’ on Windows systems.
If the value of spell-window is 0, then no context will be displayed.ABNF Checking OptionsShortLongDescription.--no-abnfdon’t perform abnf checking on the source.--abnf-add-rulesABNF file to include when checking.--abnf-program=FILENAMEspecify program to use for ABNF checkingConfiguration Filerfclint keeps configuration information in a configuration file.  By default the file is stored atOn Windows: c:\Users\USER\AppData\Local\rfclint\IETF\rfclint.cfgOtherwise: /home/USER/.local/share/rfclint/rfclint.cfgThe format of the configuration file is the standard INI file format.Spell Configurationprogram - name of the spelling program to use - defaults to aspellwindow - number of words to display on each side of a misspelled wordcolor - color to use to highlight the misspelled wordsuggest - Should suggested values be displayed? value is 0 or 1dictionaries - a comma separated list of dictionaries to includeABNF Configurationprogram - name of the ABNF program to use - defaults to bap provided w/ rfclint (bap is only installed for systems identified as nt, darwin or linux*)addRules - name of file to be processed along with rules in the sourceWindows and CursesThe version of python that ships on windows does not include a copy of the curses module as part of it.
If interactive spell checking or duplicate detection is desired on a windows system then a curses module will need to be installed independent of this package.
One place to locate a curses Python extension an be found athttps://www.lfd.uci.edu/~gohlke/pythonlibs/.
If no curses library is detected, rfclint will automatically turn on the –no-curses option.Dependenciesrfclint depends on the following packages:lxml(>= 4.1.1)requests(>= 2.5.0)rfctools_common(>= 0.5.16)sixcoloramaappdirssvgcheck‘(>=0.5.14)ChangelogVersion 0.6.1 (Fri 24 Jan)If suggestion if UTF8, then force format template to be UTF8 for Python 2.0Version 0.5.19 (Thur 29 Aug)Modify BCP14 if neededAdd <xref> marker when spell checkingChange the source tree pointerVersion 0.5.17 (Fri 16 Aug)Update documentation to match recent workAdd Copyright messages to source filesRemove space padding in display of spelling and dups.Keep the case of the first word to display for dup detectionAdd first level support for BCP 14 checking - Only reports does not fixAdd more programming checks for styleRemove Python 3.4 from supported list