[Hamlib-commits] Hamlib -- Ham radio control libraries branch master updated. 8d423e9cd133704b35712ce5359689dfe85d1464

[Nate B. <n0...@us...>]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Hamlib -- Ham radio control libraries".

The branch, master has been updated
       via  8d423e9cd133704b35712ce5359689dfe85d1464 (commit)
       via  fee7ea2425e3ba0385f8228fd1aa5d6314fb4bf9 (commit)
      from  e28e3c224bbb3cf1234e2795f2c0ba2d4ea86a6e (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 8d423e9cd133704b35712ce5359689dfe85d1464
Merge: e28e3c22 fee7ea24
Author: Nate Bargmann <n0...@n0...>
Date:   Wed May 19 21:55:59 2021 -0500

    Merge pull request #708 from N0NB/doxygen_work
    
    Add typographic conventions section to the main page


commit fee7ea2425e3ba0385f8228fd1aa5d6314fb4bf9
Author: Nate Bargmann <n0...@n0...>
Date:   Wed May 19 21:54:21 2021 -0500

    Add typographic conventions section to the main page

diff --git a/doc/index.doxygen b/doc/index.doxygen
index 58ebc9cf..1ecf5516 100644
--- a/doc/index.doxygen
+++ b/doc/index.doxygen
@@ -13,6 +13,54 @@ documentation through the tabs at the top of this page.
 
 Please report any problems to ham...@li....
 
+\section s2 Typographic conventions
+
+While Doxygen applies its own typographic conventions to the document based on
+its own stylesheets, this section details Hamlib specific conventions.
+
+\subsection sub1 Key words
+
+Key words used in program source such as `TRUE` or `FALSE` are shown in a
+constant width font.
+
+\subsection sub2 Manual pages
+
+References to Unix style manual pages are shown as `man`(1).  The manual page
+entry is in a constant width font immediately followed by parentheses
+containing a numeral denoting the section of the manual the key word can be
+found.  For example, to view `printf`(3) use:
+
+   ```
+   man 3 printf
+   ```
+
+at a terminal prompt and the `man`(1) program will display the C library
+manual page for the `printf()` function.  On most Unix type systems there are
+two `printf` manual pages, one in section 1 (user commands) and the other in
+section 3 (library calls).
+
+To learn more about manual pages:
+
+   ```
+   man man-pages
+   ```
+
+is a good starting point.
+
+If you are using a system that does not have manual pages, many HTML formatted
+pages are available on the World Wide Web.
+[The Linux man-pages project](https://www.kernel.org/doc/man-pages/)
+has many manual pages online and is the source for most system and library call
+documentation found in every Linux distribution.  The
+[Debian project also hosts a large collection of manual pages](https://manpages.debian.org/)
+drawn from the packages in its distributions.
+
+\subsection sub3 Program names and options
+
+Program names and options to programs such as the Hamlib utilities are shown
+in a constant width font, e.g. `rigctl -v` the *verbose* option to the `rigctl`(1)
+Hamlib utility.
+
 \section txtfil Distributed information files
 
 These text files are distributed with the Hamlib package.

-----------------------------------------------------------------------

Summary of changes:
 doc/index.doxygen | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)


hooks/post-receive
-- 
Hamlib -- Ham radio control libraries