# README-man
# File last changed: Nov 9, 2022

Man pages for the NCID programs.

Usage:
    make            - builds man pages from *.[17]-in
                      builds missing man pages from Perl scripts.
    make install    - installs the man pages

    Manual builds, not accessible from the top Makefile:

    make html       - builds html files from the man pages
    make all-html   - includes man pages from LCDncid
                      (The source directories must be present)

    make epub       - builds epub file from the html files

    make pdf        - builds draft pdf file from the man pages
    make pdf-all    - includes man pages from LCDncid

                      the source man pages must be present

                      the man pages may need modification or
                      the page numbers may beed to be modified
                        manuals-index-base.0
                        manuals-start.0
                      if modified, run "make clobber pdf-all"

    make update-odg - creates man.odg for the odg2pdf target
                      only needs to be run if source modified

    make odg2pdf    - builds final pdf file from the man.odg file

FirstPage.pdf Changes:
    To recreate FirstPage.pdf with a new date or other changes, use
    libreoffice or openoffice to edit FirstPage.pdf.  Make the changes
    and then do a Export as PDF.

Requirements:
    pod2man         - required for the normal build
    man2html        - required to build the html files from the man pages
    calibre         - required to build the epub book
    cat man ps2pdf  - required to build draft pdf file
    libreoffice     - required to build final pdf file
    pdfunite        - part of the poppler-utils package on Fedora

    The markdown command line program can be obtained from
    http://daringfireball.net/projects/markdown/

    The "pod2man" command line program is used to create man pages
    from the Perl scripts in the gateway/ and tools/ directories.

Extra:
    The "Markdown" command line program is used to generate text from
    a markdown file: http://daringfireball.net/projects/markdown/

The man.html is the index page for the html man pages.

The *.html documentation can be converted into other formats using:

    pandoc  - http://johnmacfarlane.net/pandoc/
    calibre - http://calibre-ebook.com/

prefix  - default: /usr/local:            $(prefix)/bin and $(prefix)/sbin
prefix2 - default: prefix2 = $(prefix1):  $(prefix2)/etc
prefix3 - default: "":                    $(prefix)/var

prefix2 controls where to look for the config file,
(the default is /usr/local)
