Rename man page from 'readability-cli', suggest symlink

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

@ -23,6 +23,8 @@ 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)`.
### Arch Linux
Arch Linux users may use the [readability-cli](https://aur.archlinux.org/packages/readability-cli/) AUR package instead.
@ -35,7 +37,7 @@ Arch Linux users may use the [readability-cli](https://aur.archlinux.org/package
where `SOURCE` is a file, an http(s) URL, or '-' for standard input
**See [readable(1)](readable.1.md) for more information, and usage examples.**
**See [readability-cli(1)](readability-cli.1.md) for more information, and usage examples.**
## Localization

@ -263,7 +263,7 @@ let args = yargs
type: "boolean",
desc: __`Print version`
})
.epilogue(__`See the manual for more info: man readable`)
.epilogue(__`See the manual for more info: man readability-cli`)
.wrap(Math.min(yargs.terminalWidth(), 100))
.strict()
.parse();

@ -34,5 +34,5 @@
"Host not found: '%s'": "Host not found: '%s'",
"Unknown mode: %s\nPlease use one of: keep, force, exit": "Unknown mode: %s\nPlease use one of: keep, force, exit",
"Use --help for more info.": "Use --help for more info.",
"See the manual for more info: man readable": "See the manual for more info: man readable"
"See the manual for more info: man readability-cli": "See the manual for more info: man readability-cli"
}

@ -34,5 +34,5 @@
"Host not found: '%s'": "Сервер не найден: '%s'",
"Unknown mode: %s\nPlease use one of: keep, force, exit": "Неизвестный режим: %s\nПожалуйста, используйте один из: keep, force, exit",
"Use --help for more info.": "Чтобы узнать больше, воспользуйтесь --help",
"See the manual for more info: man readable": "Чтобы узнать больше, загляните в мануал: man readable"
"See the manual for more info: man readability-cli": "Чтобы узнать больше, загляните в мануал: man readability-cli"
}

@ -8,9 +8,11 @@
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"man": "marked-man --version=\"$(node -p 'require(\"./package.json\").version')\" readable.1.md > readable.1"
"man": "marked-man --version=\"v$(node -p 'require(\"./package.json\").version')\" readability-cli.1.md > readability-cli.1"
},
"man": "./readable.1",
"man": [
"./readability-cli.1"
],
"repository": "gitlab:gardenappl/readability-cli",
"author": "gardenapple <gardenapple@posteo.net>",
"bugs": "https://gitlab.com/gardenappl/readability-cli/-/issues",

@ -1,4 +1,4 @@
.TH "READABILITY\-CLI" "1" "October 2021" "2.3.0" ""
.TH "READABILITY\-CLI" "1" "October 2021" "v2.3.2" ""
.SH "NAME"
\fBreadability-cli\fR \- get useful text from a web page
.SH SYNOPSYS
Loading…
Cancel
Save