diff --git a/Help.md b/Help.md new file mode 100644 index 0000000..3ccb71c --- /dev/null +++ b/Help.md @@ -0,0 +1,46 @@ +``` +$ ./ios2html -h + +ios2html version: 1.0 (created: 2018-06-01) + +BASIC USAGE... + bash ios2html [-b browser] -c case_no [-f folder] [-h] [-n] [-o officer] [-q] [-v] ios_backup + +OPTIONS: + + -b browser: The browser command to use to view the report. + (default: firefox) + -c case_no: The Case Number used in the organisation. + (MANDOTORY!) + -f folder : The output directory to use for all files. + (default: report) + -h : display usage and exit + -n : disable logging (enabled by default) + -o officer: The name of the Officer running the case. + If this is not supplied it is the real name field + for the current user in /etc/passwd or OpenDirectory. + -q : disable stdout (enabled by default) + -v : print version and exit + ios_backup: source (folder) to process (MANDOTORY!) +``` + +The help is also available per click on “ios2html” in the footer of each page. + +Only the case number (-c) and the location of the physical image (ios_backup) are mandatory. If you miss to supply a case number the script will ask you. If you leave it blank the script will exit. + +For target folder (-f) and/or ios_backup it could be supplied an absolute path, a relative path and paths with “..” in it. + +As written in the help page the output can be suppressed by the option “-q”. + +Per default the the output of stdout is also added as a non coloured log file (ios2html.log) to the report folder. + +As written in the help page with the option “-n” no log file will be written. + +The easiest way to get the log file is to click on “ios2html.log” in the horizontal navigation pane at the top of each page. + +If you want the script to display the report with another browser you can use “-b Safari” or “-b ‘Google Chrome’” under macOS or “-b epiphany“ or “-b links”. If no GUI is available you have to give “-b true”. + +You can access the other generated pages by +* clicking on the link in the horizontal navigation pane at the top of each page or +* clicking on a link in the text of a page. +