rfclint 0.5.19

对Internet草稿执行验证检查

当Internet-Draft是 开始创建RFC的进程。此工具执行这些操作的子集。 执行的操作是：

• 验证文件是否是格式正确的XML，以及它是否符合xml2rfc版本3 在RFC 7991中定义的架构。
• 验证嵌入的XML节的格式是否正确。
• 验证嵌入的ABNF是否完整且格式良好。
• 识别拼写错误的单词。
• 检测重复单词。

该工具可以在交互模式或批处理模式下使用。

用法

rfclint接受单个xml文档作为输入，并可选地输出修改后的版本 文件的。

基本用法：rfclint [options] SOURCE

常规选项

General options for the program

Short	Long	Description
^{tt2}$	^{tt3}$	purge the cache and exit
^{tt4}$	^{tt5}$	don’t use the network to resolve references
^{tt6}$	^{tt7}$	don’t check against the RNG schema
^{tt8}$	^{tt9}$	don’t print anything
.	^{tt10}$	save configuration back to config file
^{tt11}$	^{tt12}$	print extra information
^{tt13}$	^{tt14}$	display the version number and exit
^{tt15}$	^{tt16}$	don’t resolve xi:include elements
.	^{tt17}$	don’t check xml examples for well-formness
.	^{tt18}$	do checking for bcp14 keywords
.	^{tt19}$	skip check svg for limited vocabulary
^{tt20}$	^{tt21}$	specify the primary cache directory to write to
.	^{tt22}$	specify the configuration file to use
^{tt23}$	^{tt24}$	specify an output filename
^{tt25}$	^{tt26}$	specify an alternate RNG file
.	^{tt27}$	extract all source code for the given type

拼写选项

The following options affect how the spell checking is performed.

Short	Long	Description
.	^{tt28}$	don’t perform duplicate detection
.	^{tt29}$	don’t perform spell checking on the source
.	^{tt30}$	don’t provide suggestions for misspelled words
.	^{tt31}$	skip code elements when checking
.	^{tt32}$	skip artwork elements check checking
.	^{tt33}$	don’t do window based
.	^{tt34}$	specify the color to use for word highlighting
.	^{tt35}$	specify an additional dictionary to use
.	^{tt36}$	specify the personal dictionary to use
.	^{tt37}$	program to use for spell checking
.	^{tt38}$	how many words to display as part of the context

It 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检查选项

Short	Long	Description
.	^{tt39}$	don’t perform abnf checking on the source
.	^{tt40}$	ABNF file to include when checking
.	^{tt41}$	specify program to use for ABNF checking

配置文件

rfclint将配置信息保存在配置文件中。默认情况下，文件存储在

• On Windows: c:\Users\USER\AppData\Local\rfclint\IETF\rfclint.cfg
• Otherwise: /home/USER/.local/share/rfclint/rfclint.cfg

配置文件的格式是标准的ini文件格式。

拼写配置

• program - name of the spelling program to use - defaults to aspell
• window - number of words to display on each side of a misspelled word
• color - color to use to highlight the misspelled word
• suggest - Should suggested values be displayed? value is 0 or 1
• dictionaries - a comma separated list of dictionaries to include

abnf配置

• program - 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 source

窗口和诅咒

windows上提供的python版本不包含curses模块的副本。 如果需要在windows系统上进行交互式拼写检查或重复检测，则需要独立于此软件包安装curses模块。 可以在https://www.lfd.uci.edu/~gohlke/pythonlibs/找到curses python扩展的一个位置。 如果未检测到诅咒库，rfclint将自动打开–no curses选项。

依赖关系

rfclint取决于以下软件包：

• lxml（>；=4.1.1）
• requests（>；=2.5.0）
• rfctools_common（>；=0.5.16）
• 六
• 色差
• 应用程序目录
• svgcheck'（>；=0.5.14）

更改日志