✨ Add man generating script

Author: tgallone

scripts/gen-man.py

@@ -0,0 +1,137 @@
+from json import load
+from datetime import date
+
+
+###### Parameters ######
+
+# path to the help.json file
+pathToHelpFile = "../src/data/help.json"
+# man page section
+manSection = 1  
+# version (left footer)
+versionNumber = "Fastfetch 1.0" 
+# title (center header)
+titlePage = "Fastfetch man page" 
+# date (center footer)
+todayDate = date.today().strftime("%b %d %Y") # format : "Month (abreviation) Day Year"
+
+
+# text displayed in the "NAME" section
+nameSection = "fastfetch - a neofetch-like tool for fetching system \
+information and displaying them in a pretty way"    
+
+# text displayed in the "DESCRIPTION" section
+descriptionSection = "A maintained, feature-rich and performance \
+oriented, neofetch like system information tool."   
+
+# text displayed in the "BUGS" section
+bugSection = "Please report bugs to : https://github.com/fastfetch-cli/fastfetch/issues"
+
+
+###### Text Decorations Tags ######
+
+startUnderline = "\\fI" # start underline text tag
+endUnderline = "\\fR" # end underline text tag
+
+startBold = "\\fB" # start bold text tag
+endBold = "\\fR" # end bold text tag
+
+startItalic = "\\fI" # start italic text tag
+endItalic = "\\fP" # end italic text tag
+
+
+###### Argument decoration ######
+
+### optional arguments tags ###
+
+# if an optional argument is displayed as [?optArg] (with "optArg" underlined), this value should be f"[?{startUnderline}"
+startOptionalArgument = f"[{startItalic}?"
+# if an optional argument is displayed as [?optArg] (with "optArg underlined"), this value should be f"{endUnderline}]"
+endOptionalArgument = f"{endItalic}]" 
+
+# mandatory arguments tags
+startMandatoryArgument = "" 
+endMandatoryArgument = ""
+
+def generateManPage():
+
+    # importing the JSON file
+    try:
+        with open(pathToHelpFile, 'r') as jsonFile:
+            helpFileData = load(jsonFile) # json.load
+    except IOError as error:
+        print("Error with file", pathToHelpFile, ":", error)
+        return
+    
+
+    ######## Start printing the generated .1 file ########
+
+
+    ###### header, footer & config #####
+
+    print(f".TH man {manSection}", end=" ")
+    print(f"\"{todayDate}\"", end=" ")
+    print(f"\"{versionNumber}\"", end=" ")
+    print(f"\"{titlePage}\"")
+
+
+    ###### Name ######
+
+    print(".SH NAME")
+    print(nameSection)
+
+
+    ##### Synopsis ######
+
+    print(".SH SYNOPSIS")
+    print(".B fastfetch")
+    print(f"[{startUnderline}OPTIONS{endUnderline}]")
+
+
+    ##### Description #####
+
+    print(".SH DESCRIPTION")
+    print(descriptionSection)
+
+
+    ###### Options ######
+
+    print(".SH OPTIONS")
+
+    # loop through every options sections
+    for key, value in helpFileData.items():
+
+        # print new subsection
+        print(f".SS {key}:")
+
+        # loop through every option in a section
+        for option in value:
+            # list of existing keys for this option
+            keyList = option.keys()
+
+            # start a new "option" entry
+            print(".TP")
+            print(startBold, end="")
+
+            # short option (-opt)
+            if "short" in keyList:
+                print(f"\-{ option['short'] }", end="")
+                # if also have a long option, print a comma
+                if "long" in keyList:
+                    print(", ", end="")
+
+            # long option (--option)
+            if "long" in keyList:
+                print(f"\-\-{ option['long'] }", end="")
+
+            print(endBold, end=" ")
+            
+            
+
+
+
+
+
+
+if __name__ == "__main__":
+    generateManPage()