Slightly change wording in README and man page

main
gardenapple 3 years ago
parent 4d49548f8f
commit aaf413a379
No known key found for this signature in database
GPG Key ID: CAF17E9ABE789268

@ -23,7 +23,7 @@ Here is a before-and-after comparison, using [an article from The Guardian](http
`npm install -g readability-cli`
Note to package maintainers: it might be a good idea to provide a symlink, so the man page can be accessed either as `readability-cli(1)` or as `readable(1)`.
(Note to package maintainers: it might be a good idea to provide a symlink, so the man page can be accessed either as `readability-cli(1)` or as `readable(1)`.)
### Arch Linux

@ -9,9 +9,9 @@
\fBreadability\-cli\fR takes any HTML page and strips out unnecessary bloat, leaving only the core text content\. The resulting HTML may be suitable for terminal browsers, text readers, and other uses\.
.P
This package provides the \fBreadable\fR command, which uses Mozilla's Readability library\. The same library is used in Firefox's Reader View\.
.SH OPTIONS
.P
The \fISOURCE\fR can be a URL, a file, or '\-' for standard input\.
.SH OPTIONS
.P
\fB\-\-help\fP
.RS 0
@ -191,7 +191,7 @@ Permission denied: can't read file
T}
.TE
.P
* By "standard error codes" I mean "close to a standard"\. And by that I mean: I actually don't remember any command line tools which use this convention\. You may find more info in \fBsysexits\fR(3), or maybe just \fIsysexits\.h\fR\|\.
* By "standard error codes" I mean "close to a standard"\. And by that I mean: I don't remember any command line tools which actually use this convention\. You may find more info in \fBsysexits\fR(3), or maybe just \fIsysexits\.h\fR\|\.
.SH ENVIRONMENT
.P
\fBreadability\-cli\fR supports localization, using the environment variables \fBLC_ALL\fP, \fBLC_MESSAGES\fP, \fBLANG\fP and \fBLANGUAGE\fP, in that order\. Only one language at a time is supported\.

@ -10,10 +10,10 @@
This package provides the **readable** command, which uses Mozilla's Readability library. The same library is used in Firefox's Reader View.
## OPTIONS
The *SOURCE* can be a URL, a file, or '-' for standard input.
## OPTIONS
`--help`
* Show help message, and exit.
@ -107,7 +107,7 @@ As usual, exit code 0 indicates success, and anything other than 0 is an error.
| **68** | Unknown host name for URL |
| **77** | Permission denied: can't read file |
\* By "standard error codes" I mean "close to a standard". And by that I mean: I actually don't remember any command line tools which use this convention. You may find more info in **sysexits**(3), or maybe just *sysexits.h*.
\* By "standard error codes" I mean "close to a standard". And by that I mean: I don't remember any command line tools which actually use this convention. You may find more info in **sysexits**(3), or maybe just *sysexits.h*.
## ENVIRONMENT

Loading…
Cancel
Save