doc: adding tinyrad-strings man page

2 files changed, 103 insertions, 0 deletions

diff --git a/doc/mans/tinyrad-strings.5.in b/doc/mans/tinyrad-strings.5.in
new file mode 100644
index 0000000..632e7f5
--- /dev/null
+++ b/doc/mans/tinyrad-strings.5.in
@@ -0,0 +1,102 @@
+.\"
+.\" Tiny RADIUS Client Library
+.\" Copyright (C) 2022 David M. Syzdek <david@syzdek.net>.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are
+.\" met:
+.\"
+.\"    * Redistributions of source code must retain the above copyright
+.\"      notice, this list of conditions and the following disclaimer.
+.\"    * Redistributions in binary form must reproduce the above copyright
+.\"      notice, this list of conditions and the following disclaimer in the
+.\"      documentation and/or other materials provided with the distribution.
+.\"    * Neither the name of David M. Syzdek nor the
+.\"      names of its contributors may be used to endorse or promote products
+.\"      derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+.\" IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+.\" THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DAVID M. SYZDEK BE LIABLE FOR
+.\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.TH "TINYRAD-STRINGS" "5" "@RELEASE_MONTH@" "@PACKAGE_NAME@" "Library Functions Manual"
+.SH NAME
+tinyrad-strings - Tiny RADIUS string conventions
+.PP
+.SH ESCAPE SEQUENCES
+Spme strings enclosed in double quotes make use of escape sequences, which are
+replaced at runtime:
+.RS
+.IP \fI\er\fR
+newline (hex value \fI0A\fR)
+.IP \fI\er\fR
+carriage return (hex value \fI0D\fR)
+.IP \fI\et\fR
+horizontal tab (hex value \fI09\fR)
+.IP \fI\ev\fR
+vertical tab (hex value \fI0B\fR)
+.IP \fI\e"\fR
+double quotation mark (hex value \fI22\fR)
+.IP \fI\e'\fR
+apostrophe or single quotation mark (hex value \fI27\fR)
+.IP \fI\e?\fR
+question mark (hex value \fI3f\fR)
+.IP \fI\e\e\fR
+backslash (hex value \fI5c\fR)
+.IP \fI\ennn\fR
+The byte whose numerical value is given by \fInnn\fR interpreted as an octal
+number
+.IP \fI\exnn\fR
+The byte whose numerical value is given by \fInn\fR interpreted as a
+hexadecimal number
+.RE
+.SH TOKEN EXPANSION
+Spme strings enclosed in double quotes make use of tokens, which are expanded
+at runtime:
+.RS
+.IP \fI%%\fR
+A literal `\fI%\fR' (hex value \fI25\fR)
+.IP \fI%D\fR
+The local domain name
+.IP \fI%d\fR
+The local user's home directory
+.IP \fI%G\fR
+The local group ID
+.IP \fI%g\fR
+The local group name
+.IP \fI%H\fR
+The local hostname, including the domain name.
+.IP \fI%h\fR
+The local hostname, without the domain name.
+.IP \fI%P\fR
+process ID
+.IP \fI%P\fR
+process name (set using \fITRAD_OPT_DEBUG_IDENT\fR)
+.IP \fI%U\fR
+The local user ID
+.IP \fI%u\fR
+The local username
+.RE
+.SH SEE ALSO
+.BR tinyrad (1),
+.BR tinyrad (3),
+.BR tinyrad-dict (1),
+.BR tinyrad.conf (5),
+.PP
+.SH AUTHOR
+David M. Syzdek <david@syzdek.net>
+.PP
+.SH ACKNOWLEDGEMENTS
+\fB@PACKAGE_NAME@\fR is developed and maintained by David M. Syzdek
+<david@syzdek.net>.
+
+.\" end of man page
diff --git a/doc/mans/tinyrad.3.in b/doc/mans/tinyrad.3.in
index 008dced..182d3e3 100644
--- a/doc/mans/tinyrad.3.in
+++ b/doc/mans/tinyrad.3.in
@@ -71,6 +71,7 @@ copies into a buffer an error message corresponding to an error code
 .BR tinyrad (1),
 .BR tinyrad_error (3),
 .BR tinyrad_options (3)
+.BR tinyrad-strings (5)
 
 .SH AUTHOR
 David M. Syzdek <david@syzdek.net>