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

README update.

Browse source
This commit is contained in:
Johannes Findeisen 2023-08-29 01:54:20 +02:00
commit 900b5359ff
1 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -3,7 +3,7 @@
man2book is a tool to create a custom book of installed man pages or a man2book is a tool to create a custom book of installed man pages or a
selection of manpage sections and / or pages. selection of manpage sections and / or pages.
**After only one day of development the first stable code is here. At all it took me about two **After only one day of development the first stable code is here. At all it took me about two
days thinking about to start coding my idea... Here is the result!** days thinking about to start coding my idea... Here is the result!**
**\o/** **\o/**
@ -14,22 +14,22 @@ Hope this is useful to someone. Have fun!
### Why man pages as a book? ### Why man pages as a book?
Because I want to read them comfortable on my ebook reader when traveling but all or some selected Because I want to read them comfortable on my ebook reader when traveling but all or some selected
man pages in one or multiple books. Not more... ;) man pages in one or multiple books. Not more... ;)
### Which manpage sections are supported by man2book? ### Which manpage sections are supported by man2book?
Currently, the following manpage sections are supported, but it can support other custom sections: Currently, the following manpage sections are supported, but it can support other custom sections:
1. User commands; man-pages includes a small number of Section 1 pages that document programs 1. User commands; man-pages includes a small number of Section 1 pages that document programs
supplied by the GNU C library. supplied by the GNU C library.
2. System calls documents the system calls provided by the Linux kernel. 2. System calls documents the system calls provided by the Linux kernel.
3. Library functions documents the functions provided by the standard C library. 3. Library functions documents the functions provided by the standard C library.
4. Devices documents details of various devices, most of which reside in /dev. 4. Devices documents details of various devices, most of which reside in /dev.
5. Files describes various file formats and filesystems, and includes proc(5), which documents 5. Files describes various file formats and filesystems, and includes proc(5), which documents
the /proc file system. the /proc file system.
7. Overviews, conventions, and miscellaneous. 7. Overviews, conventions, and miscellaneous.
8. Superuser and system administration commands; man-pages includes a small number of Section 8 8. Superuser and system administration commands; man-pages includes a small number of Section 8
pages that document programs supplied by the GNU C library. pages that document programs supplied by the GNU C library.
Source: [https://www.kernel.org/doc/man-pages/](https://www.kernel.org/doc/man-pages/) Source: [https://www.kernel.org/doc/man-pages/](https://www.kernel.org/doc/man-pages/)
@ -48,7 +48,6 @@ Source: [https://www.kernel.org/doc/man-pages/](https://www.kernel.org/doc/man-p
(maybe nice but unmaintained)~~ (maybe nice but unmaintained)~~
- ~~https://docutils.sourceforge.io/ - Python - ~~https://docutils.sourceforge.io/ - Python
(as I can see now it only converts from .rst files.)~~ (as I can see now it only converts from .rst files.)~~
- ~~https://github.com/hanez/aov-html2epub - Bash~~
## Workflow ## Workflow
@ -77,16 +76,16 @@ feature ideas:
- Maybe support for other converters / generators. - Maybe support for other converters / generators.
- Links to other man pages as mentioned in the footer of all man pages, e.g.: pam(8). - Links to other man pages as mentioned in the footer of all man pages, e.g.: pam(8).
But only if available in the current book. But only if available in the current book.
- Maybe a progress bar instead of printing for every file being processed - Maybe a progress bar instead of printing for every file being processed
(https://www.geeksforgeeks.org/progress-bars-in-python/). (https://www.geeksforgeeks.org/progress-bars-in-python/).
## Bugs ## Bugs
- Includes in man pages does not work. Need to discover this, but I do not - Includes in man pages does not work. Need to discover this, but I do not
know how to solve this and if Pandoc supports that (maybe when setting some include know how to solve this and if Pandoc supports that (maybe when setting some include
path somewhere?). path somewhere?).
## Links ## Links
- [The Linux man-pages project](https://www.kernel.org/doc/man-pages/) - I found this - [The Linux man-pages project](https://www.kernel.org/doc/man-pages/) - I found this
project after researching a little for my idea and it inspired me a lot to start my project. project after researching a little for my idea and it inspired me a lot to start my project.