From e5e228fef04f465a5b80be6489a6157c83cd0940 Mon Sep 17 00:00:00 2001
From: gardenapple <gardenapple@posteo.net>
Date: Fri, 15 Oct 2021 20:23:33 +0300
Subject: [PATCH] Rename man page from 'readability-cli', suggest symlink

---
 README.md                             | 4 +++-
 index.js                              | 2 +-
 locales/en.json                       | 2 +-
 locales/ru.json                       | 2 +-
 package.json                          | 6 ++++--
 readable.1 => readability-cli.1       | 2 +-
 readable.1.md => readability-cli.1.md | 0
 7 files changed, 11 insertions(+), 7 deletions(-)
 rename readable.1 => readability-cli.1 (99%)
 rename readable.1.md => readability-cli.1.md (100%)

diff --git a/README.md b/README.md
index 3cde1c4..2c85f8b 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/index.js b/index.js
index 0de1ba0..9a326ac 100755
--- a/index.js
+++ b/index.js
@@ -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();
diff --git a/locales/en.json b/locales/en.json
index 25160a6..fe0f3af 100644
--- a/locales/en.json
+++ b/locales/en.json
@@ -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"
 }
diff --git a/locales/ru.json b/locales/ru.json
index 23e45ff..a752137 100644
--- a/locales/ru.json
+++ b/locales/ru.json
@@ -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"
 }
diff --git a/package.json b/package.json
index 3964095..4d7f03b 100644
--- a/package.json
+++ b/package.json
@@ -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",
diff --git a/readable.1 b/readability-cli.1
similarity index 99%
rename from readable.1
rename to readability-cli.1
index b1cba01..09fb7b5 100644
--- a/readable.1
+++ b/readability-cli.1
@@ -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
diff --git a/readable.1.md b/readability-cli.1.md
similarity index 100%
rename from readable.1.md
rename to readability-cli.1.md