README.md (1216B)
1 ``` console 2 ██▄██ ▄▄█▄ ▄█ ▄▄ 3 ██ ▄█ ▄▄██ ██ ▄█ 4 █▄▄▄█▄▄▄██▄██▄██ 5 ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ 6 7 ietf 0.2.1 8 CLI for reading IETF RFCs. 9 10 USAGE: 11 ietf [OPTIONS] [SUBCOMMAND] 12 13 FLAGS: 14 -h, --help Prints help information 15 -V, --version Prints version information 16 17 OPTIONS: 18 -n, --number <serial> RFC Serial Number 19 -r, --remove <serial> RFC Serial Number 20 21 SUBCOMMANDS: 22 clean Remove the rfc directory 23 help Prints this message or the help of the given subcommand(s) 24 update Update RFC Index 25 ``` 26 27 ## Features 28 * RFC index browser 29 * Read By RFC number 30 * Local Storage in (`~/rfc/` on unix systems and `C:\Users\{NAME}` on 31 windows) 32 * Pager 33 34 ## Guide 35 36 ### Installing 37 You can install it with the Rust package manager 38 [Cargo](https://github.com/rust-lang/cargo) like this: 39 40 ``` bash 41 $ cargo install ietf 42 ``` 43 44 ### View RFC index 45 46 ``` bash 47 $ ietf 48 ``` 49 50 ### Read RFC by number 51 ``` bash 52 $ ietf -n 1 53 ``` 54 55 ### Remove an RFC 56 ``` bash 57 $ ietf -r 1 58 ``` 59 60 ### Remove the RFC storage directory: 61 ``` bash 62 $ ietf clean 63 ``` 64 65 ### Update/Download RFC index 66 67 ``` bash 68 $ ietf update 69 ```