hanez/man2book
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Some cleanups and fixes.

Browse source
This commit is contained in:
Johannes Findeisen 2022-10-19 13:48:00 +02:00
commit 01633ed147
4 changed files with 19 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -2,9 +2,9 @@
A tool to convert all installed man pages to a simple ebook or other formats with contents in the head.
Maybe this could be only a small shell script but if not I will use Python.
~~Maybe this could be only a small shell script but if not I will use Python.~~ - It is Python now... :)
## Why man pages as ebook?
## Why man pages as book?
Because I want to read them comfortable on my ebook reader when traveling but all man pages in one book.
Not more... ;)
@ -15,23 +15,23 @@ Not more... ;)
https://pypi.org/project/pypandoc/ or https://pypi.org/project/pandoc/.
(very mature features for document conversion like direct manpage input and epub output,
but I don't know much about pandoc, so I need to discover this.)
- https://www.gnu.org/software/groff/
(man -Thtml df > df.html)
- https://linux.die.net/man/1/man2html
(is nice because it must not generate html, head and body)
- https://pypi.org/project/epubmaker/ - Python
(maybe nice but unmaintained)
- https://docutils.sourceforge.io/ - Python
(as I can see now it only converts from .rst files.)
- https://github.com/hanez/aov-html2epub - Bash
- ~~https://www.gnu.org/software/groff/
(man -Thtml df > df.html)~~
- ~~https://linux.die.net/man/1/man2html
(is nice because it must not generate html, head and body)~~
- ~~https://pypi.org/project/epubmaker/ - Python
(maybe nice but unmaintained)~~
- ~~https://docutils.sourceforge.io/ - Python
(as I can see now it only converts from .rst files.)~~
- ~~https://github.com/hanez/aov-html2epub - Bash~~
## Workflow
1. Read manpage sections
2. Create HTML file for each manpage in each section
3. Read and store title(metadata) for in each file
4. Remove all unneeded stuff like html, head and body in each file
5. Create TOC for the entire ebook
1. ~~Read manpage sections~~
2. ~~Create HTML file for each manpage in each section~~
3. ~~Read and store title(metadata) for in each file~~
4. ~~Remove all unneeded stuff like html, head and body in each file~~
5. ~~Create TOC for the entire ebook~~
6. Create a header HTML file for the ebook containing the head tag
7. Merge toc and content of all files for preparing the ebook
8. Merge the header file with the prepared ebook while inserting html and body tags which should result in a valid HTML file