Lot of small enhancements, fixes and new ideas in README.

README.md

@@ -1,13 +1,38 @@
 # man2book
 
-A tool to convert all installed man pages to a simple ebook or other formats with contents in the head.
+man2book is a tool to create a custom book of installed man pages or a
+selection of manpage sections and / or pages.
 
-~~Maybe this could be only a small shell script but if not I will use Python.~~ - It is Python now... :)
+**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!**
 
-## Why man pages as book?
+**\o/**
 
-Because I want to read them comfortable on my ebook reader when traveling but all man pages in one book.
+Hope this is useful to someone. Have fun!
-Not more... ;)
+
+## FAQ
+
+### Why man pages as a book?
+
+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... ;)
+
+### Which manpage sections are supported by man2book?
+
+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 
+supplied by the GNU C library.
+2. System calls documents the system calls provided by the Linux kernel.
+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.
+5. Files describes various file formats and filesystems, and includes proc(5), which documents 
+the /proc file system.
+7. Overviews, conventions, and miscellaneous.
+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.
+
+Source: [https://www.kernel.org/doc/man-pages/](https://www.kernel.org/doc/man-pages/)
 
 ## Helpful libraries and tools
 
@@ -34,5 +59,34 @@ Not more... ;)
 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
+8. Merge the header file with the prepared ebook while inserting html and body
+   tags which should result in a valid HTML file
 9. Create ebook from the resulting HTML file using Pandoc
+
+## Future
+
+When the above steps are done, and we could build a complete book there are some
+feature ides:
+
+- Some kind of template for the book including a cover.
+- Image support for the cover.
+- Maybe a footer for pages and the complete book.
+- Page numbers on all pages after the table of contents. Like in real books.
+- Support all output formats of Pandoc. This should be easy since I do not do any
+  special here. Pandoc is my base converter /generator.
+- Maybe support for other converters / generators.
+- 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.
+- Maybe a progress bar instead of printing for every file being processed. 
+(https://www.geeksforgeeks.org/progress-bars-in-python/)
+
+## Bugs
+
+- 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 
+path somewhere?).
+
+## Links
+
+- [The Linux man-pages project](https://www.kernel.org/doc/man-pages/) - I found this 
+project after researching a little for my idea and inspired me a lot to start my project.

man2book

@@ -1,4 +1,27 @@
 #!/usr/bin/python3
+"""
+This file is part of man2book (https://git.unixpeople.org/hanez/man2book)
+Copyright (c) 2022 Johannes Findeisen <you@hanez.org>. All Rights Reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next
+paragraph) shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
+OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""
+
 import argparse
 import os
 import re
@@ -6,55 +29,64 @@ import re
 from bs4 import BeautifulSoup
 
 __author__ = 'Johannes Findeisen <you@hanez.org>'
-__version__ = '0.1.0'
+# currently i only increase the third number because i commit early and often and nearly on every
+# commit there are new features. 0.2.0 will be ready for generating a full book. then i will use the
+# pythonic version scheme.
+__version__ = '0.1.1'
 
 MANPAGE_PATH = '/usr/share/man/'
 
-parser = argparse.ArgumentParser(
+
+def main():
+    parser = argparse.ArgumentParser(
         description='man2book is a tool to create a custom book of installed man pages or a '
-                'selection of manpage sections and pages.',
+                    'selection of manpage sections and / or pages.',
         epilog='author: ' + __author__,
         prog='man2book')
 
-parser.add_argument('-c', '--clean', default=False, dest='clean', action='store_true',
+    parser.add_argument('-c', '--clean', default=False, dest='clean', action='store_true',
                         help='clean temporary files after processing (default: false)')
 
-parser.add_argument('-d', '--debug', default=False, dest='debug', action='store_true',
+    parser.add_argument('-d', '--debug', default=False, dest='debug', action='store_true',
                         help='be verbose and print debug information (default: false)')
 
-parser.add_argument('-l', '--limit', default=0, dest='limit', type=int,
+    parser.add_argument('-l', '--limit', default=0, dest='limit', type=int,
-                    help='maximum number of files generated in each section. this is set to the '
+                        help='maximum number of files generated in each section. this is set to '
-                         'number of commands to create a chapter for. only useful when debugging a '
+                             'the number of commands to create a chapter for. only useful when '
-                         'full section genration (default: 0; no limit)')
+                             'debugging a full section genration (default: 0; no limit)')
 
-parser.add_argument('-m', '--manpages', help='limit only to a subset of man pages. e.g. cd or a '
+    parser.add_argument('-m', '--manpages', help='limit only to a subset of man pages. e.g. cd or '
-                                             'list like cd,df,mv. this feature is not 100% '
+                                                 'a list like cd,df,mv. this feature is not 100% '
-                                             'reliable at the moment because it should be possible '
+                                                 'reliable at the moment because it should be '
-                                             'to set the section here optionally for each manpage! '
+                                                 'possible to set the section here optionally for '
-                                             'e.g. df.1. it is not very important actually.')
+                                                 'each manpage! e.g. df.1. it is not very '
+                                                 'important actually.')
 
+    parser.add_argument('-s', '--sections', help='the manpage sections. e.g. 8 or a list like '
+                                                 '1,2,3')
 
-parser.add_argument('-s', '--sections', help='the manpage sections. e.g. 8 or a list like 1,2,3')
+    parser.add_argument('target_directory', metavar='TARGET_DIRECTORY',
+                        help='the target directory for the output. it must contain two directories.'
+                             'one is the directory for tempory file output (tmp/) and one for the '
+                             'final processing result (out).')
 
-parser.add_argument("target_directory", metavar="TARGET_DIRECTORY",
+    parser.add_argument('-v', '--version', action='version', version='%(prog)s ' + str(__version__))
-                    help="the target directory for the output. it must contain two directories."
-                         "one is the directory for tempory file output (tmp/) and one for the "
-                         "final processing result (out).")
 
-parser.add_argument('-v', '--version', action='version', version='%(prog)s ' + str(__version__))
+    parser.add_argument('-z', '--zero', default=False, dest='zero', action='store_true',
+                        help='do not show any output at execution (default: false)')
 
-args = parser.parse_args()
+    args = parser.parse_args()
 
-output_dir = args.target_directory + 'out/'
+    output_dir = args.target_directory + 'out/'
-sections = ['1', '2', '3', '4', '5', '6', '7', '8']
+    sections = ['1', '2', '3', '4', '5', '6', '7', '8']
-tmp_dir = args.target_directory + 'tmp/'
+    tmp_dir = args.target_directory + 'tmp/'
-toc = {}
+    toc = {}
 
-if args.sections:
+    if args.sections:
         args_sections = args.sections.split(',')
         new_sections = []
         for section in args_sections:
-        # maybe make sections just a default which could be overridden in the cli. for now you
+            # maybe make sections just a default which could be overridden in the cli. for now, you
             # can set sections in the cli which are defined in "sections" above.
             if section not in sections:
                 print('section ' + section + ' not found! aborting...')
@@ -62,8 +94,10 @@ if args.sections:
             new_sections.append(section)
         sections = new_sections
 
-i = 1
+    i = 1
-for section in sections:
+    overall_count = 0
+    for section in sections:
+        count = 0
         args_manpages = []
         manpage_files = []
         if args.manpages:
@@ -89,6 +123,12 @@ for section in sections:
         for manpage_file in manpage_files:
             manpage = os.path.splitext(os.path.basename(manpage_file))[0]
             command = os.path.splitext(manpage)[0]
+            count += 1
+            overall_count = overall_count + len(manpage_files)
+            if not args.zero:
+                print('progress: ' + str(count) + '/' + str(len(manpage_files)) +
+                      ' processing section: ' + str(section) + ' using manpage: ' + str(manpage))
+
             try:
                 if args.manpages:
                     if stop is True:
@@ -180,3 +220,12 @@ for section in sections:
                 if i == args_limit:
                     break
                 i += 1
+
+        print('processed: ' + str(overall_count) + ' man pages')
+
+
+if __name__ == "__main__":
+    try:
+        main()
+    except KeyboardInterrupt as err:
+        print('man2book terminated by user!')