HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

idnits — Check internet-drafts for submission nits. Looks for violations of Section 2.1 and 2.2 of the requir

Submitted by: @import:tldr-pages··
0
Viewed 0 times
submissioncommanddraftsidnitsclicheckforinternet

Problem

How to use the idnits command: Check internet-drafts for submission nits. Looks for violations of Section 2.1 and 2.2 of the requirements listed on <https://www.ietf.org/id-info/checklist>. More information: <https://github.com/ietf-tools/idnits>.

Solution

idnits — Check internet-drafts for submission nits. Looks for violations of Section 2.1 and 2.2 of the requirements listed on <https://www.ietf.org/id-info/checklist>. More information: <https://github.com/ietf-tools/idnits>.

Check a file for nits:
idnits {{path/to/file.txt}}


Count nits without displaying them:
idnits --nitcount {{path/to/file.txt}}


Show extra information about offending lines:
idnits --verbose {{path/to/file.txt}}


Expect the specified year in the boilerplate instead of the current year:
idnits --year {{2021}} {{path/to/file.txt}}


Assume the document is of the specified status:
idnits --doctype {{standard|informational|experimental|bcp|ps|ds}} {{path/to/file.txt}}

Code Snippets

Check a file for nits

idnits {{path/to/file.txt}}

Count nits without displaying them

idnits --nitcount {{path/to/file.txt}}

Show extra information about offending lines

idnits --verbose {{path/to/file.txt}}

Expect the specified year in the boilerplate instead of the current year

idnits --year {{2021}} {{path/to/file.txt}}

Assume the document is of the specified status

idnits --doctype {{standard|informational|experimental|bcp|ps|ds}} {{path/to/file.txt}}

Context

tldr-pages: common/idnits

Revisions (0)

No revisions yet.