Metadata-Version: 2.0
Name: rfc-reader
Version: 0.2
Summary: A tool to read and search through IETF RFC documents
Home-page: https://github.com/monsieurh/rfc_reader
Author: monsieur_h
Author-email: ray.hubert@gmail.com
License: GPL3
Keywords: RFC rfc IETF
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Legal Industry
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: License :: Public Domain
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Topic :: Internet
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Debuggers

# rfc_reader
The CLI RFC reader for linux :
- Allows one to update a list of local RFC documents
- Allows to open a RFC with any given program (default: `$PAGER` or `less`)


## Usage : (`rfc --help` or `rfc -h` to invoke)
```shell
usage: rfc [-h] [--update] [--pager PAGER] RFC_NUMBER

rfc is the python RFC reader. It stores a local copy of all the RFC documents
and allows one to search a read through them.For more info and contact : See
https://github.com/monsieurh/rfc_reader

positional arguments:
  RFC_NUMBER            Opens the RFC_NUMBER for reading

optional arguments:
  -h, --help            show this help message and exit
  --update              Updates the local copy of RFC documents with the
                        latest (weekly) publication of the IETF
  --pager PAGER, -p PAGER
                        Uses the given program to open RFC documents. Default
                        program is env var $PAGER or `less` if not found

Released under GPLv3

```

## Behavior :
rfc_reader will download and/or update all RFC txt documents from [rfc-editor-website](https://www.rfc-editor.org/) to `~/.rfc`. 

The program then allows to open a RFC document by invoking :

`rfc <number>` where <number> is the identifier of the RFC.

or :
`rfc -p <program> <number>` so the docment is opened by <program>

## Examples :
`rfc 2119` opens the Key words RFC in the default `$PAGER` program (usually `less`)

`rfc -p gedit 2119` opens the same document in gedit

## Future :
- Keyword and title based searches and filters
- Scheduled updates (as opposed to manual)

