summary refs log tree commit diff
path: root/doc/rfc/rfc.1
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2021-01-18 16:56:05 -0500
committerJune McEnroe <june@causal.agency>2021-01-18 16:56:05 -0500
commit3ad036b9a04811da71977fac5dc7ab6971f622bc (patch)
treecf8d976262922ce59df5b2053c385a64e86c9e10 /doc/rfc/rfc.1
parentPublish "reusing tags" (diff)
downloadsrc-3ad036b9a04811da71977fac5dc7ab6971f622bc.tar.gz
src-3ad036b9a04811da71977fac5dc7ab6971f622bc.zip
Don't compress RFCs, add rfc(1) command
Diffstat (limited to 'doc/rfc/rfc.1')
-rw-r--r--doc/rfc/rfc.153
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/rfc/rfc.1 b/doc/rfc/rfc.1
new file mode 100644
index 00000000..ece5a901
--- /dev/null
+++ b/doc/rfc/rfc.1
@@ -0,0 +1,53 @@
+.Dd January 18, 2021
+.Dt RFC 1
+.Os
+.
+.Sh NAME
+.Nm rfc ,
+.Nm rfctags
+.Nd view IETF RFCs
+.
+.Sh SYNOPSIS
+.Nm rfc
+.Op Ar number
+.Nm rfctags
+.Op Ar
+.
+.Sh DESCRIPTION
+The
+.Nm rfc
+utility displays
+an IETF RFC by number,
+or the RFC index if no number is specified.
+The RFC is displayed in the
+.Ev PAGER
+with a tags file generated by
+.Nm rfctags .
+.
+.Pp
+The
+.Nm rfctags
+utility generates tags
+for RFC text file
+section numbers,
+section names
+and bracketed references.
+.
+.Sh ENVIRONMENT
+.Bl -tag -width Ds
+.It Ev PAGER
+The program used to display RFCs.
+It must accept the
+.Fl T
+flag for specifying
+the path of the tags file.
+The default is
+.Ev PAGER=less .
+.El
+.
+.Sh SEE ALSO
+.Xr ctags 1 ,
+.Xr less 1
+.
+.Sh AUTHORS
+.An June Bug Aq Mt june@causal.agency