From aaf413a3791650c8fe992b2ff2787a14ec5209ff Mon Sep 17 00:00:00 2001 From: gardenapple Date: Fri, 15 Oct 2021 22:56:31 +0300 Subject: [PATCH] Slightly change wording in README and man page --- README.md | 2 +- readability-cli.1 | 4 ++-- readability-cli.1.md | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2c85f8b..1b2bb26 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/readability-cli.1 b/readability-cli.1 index 09fb7b5..99b253a 100644 --- a/readability-cli.1 +++ b/readability-cli.1 @@ -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\. diff --git a/readability-cli.1.md b/readability-cli.1.md index c8fabec..2997ff6 100644 --- a/readability-cli.1.md +++ b/readability-cli.1.md @@ -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