diff options
author | P. J. McDermott <pjm@nac.net> | 2012-08-01 02:31:39 (EDT) |
---|---|---|
committer | P. J. McDermott <pjm@nac.net> | 2012-08-01 02:31:39 (EDT) |
commit | 009c0678f5fe529d8cf5b71489f3083b45581f9a (patch) | |
tree | 7ed4a859fc5a396d8d392284dc674502996e92be | |
parent | 13a73dd8ee1d0d518e781a5ea06f1ff4e7aff4ed (diff) |
Document functions in messages library.
-rw-r--r-- | man/oh_error.3.in | 43 | ||||
-rw-r--r-- | man/oh_help.3.in | 32 | ||||
-rw-r--r-- | man/oh_info.3.in | 42 | ||||
-rw-r--r-- | man/oh_usage.3.in | 32 | ||||
-rw-r--r-- | man/oh_version.3.in | 32 | ||||
-rw-r--r-- | man/oh_warn.3.in | 42 |
6 files changed, 223 insertions, 0 deletions
diff --git a/man/oh_error.3.in b/man/oh_error.3.in new file mode 100644 index 0000000..86ec260 --- /dev/null +++ b/man/oh_error.3.in @@ -0,0 +1,43 @@ +.TH oh_error 3 "@@DATE@@" "@@PACKAGE@@-@@VERSION@@" "@@DESCRIPTION@@" + +.SH NAME +oh_error - print an error message and exit + +.SH SYNOPSIS +.B . @@LIBDIR@@/messages +.P +.B oh_error +.I format +.RI [ argument ]... + +.SH DESCRIPTION +.BR oh_error () +prints +.IR argument s +according to +.I format +and then exits the application. +.P +See +.BR printf (1) +for the syntax of +.IR format . + +.SH RETURN VALUE +None. + +.SH COPYRIGHT +Copyright (C) 2012 Patrick "P. J." McDermott +.P +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.P +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. +.P +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. diff --git a/man/oh_help.3.in b/man/oh_help.3.in new file mode 100644 index 0000000..e03ba98 --- /dev/null +++ b/man/oh_help.3.in @@ -0,0 +1,32 @@ +.TH oh_help 3 "@@DATE@@" "@@PACKAGE@@-@@VERSION@@" "@@DESCRIPTION@@" + +.SH NAME +oh_help - print the application help string + +.SH SYNOPSIS +.B . @@LIBDIR@@/messages +.P +.B oh_help + +.SH DESCRIPTION +.BR oh_help () +prints the application help string. + +.SH RETURN VALUE +None. + +.SH COPYRIGHT +Copyright (C) 2012 Patrick "P. J." McDermott +.P +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.P +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. +.P +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. diff --git a/man/oh_info.3.in b/man/oh_info.3.in new file mode 100644 index 0000000..7bd2a5b --- /dev/null +++ b/man/oh_info.3.in @@ -0,0 +1,42 @@ +.TH oh_info 3 "@@DATE@@" "@@PACKAGE@@-@@VERSION@@" "@@DESCRIPTION@@" + +.SH NAME +oh_info - print an informational message + +.SH SYNOPSIS +.B . @@LIBDIR@@/messages +.P +.B oh_info +.I format +.RI [ argument ]... + +.SH DESCRIPTION +.BR oh_info () +prints +.IR argument s +according to +.IR format. +.P +See +.BR printf (1) +for the syntax of +.IR format . + +.SH RETURN VALUE +None. + +.SH COPYRIGHT +Copyright (C) 2012 Patrick "P. J." McDermott +.P +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.P +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. +.P +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. diff --git a/man/oh_usage.3.in b/man/oh_usage.3.in new file mode 100644 index 0000000..7518204 --- /dev/null +++ b/man/oh_usage.3.in @@ -0,0 +1,32 @@ +.TH oh_usage 3 "@@DATE@@" "@@PACKAGE@@-@@VERSION@@" "@@DESCRIPTION@@" + +.SH NAME +oh_usage - print the application usage string + +.SH SYNOPSIS +.B . @@LIBDIR@@/messages +.P +.B oh_usage + +.SH DESCRIPTION +.BR oh_usage () +prints the application usage string. + +.SH RETURN VALUE +None. + +.SH COPYRIGHT +Copyright (C) 2012 Patrick "P. J." McDermott +.P +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.P +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. +.P +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. diff --git a/man/oh_version.3.in b/man/oh_version.3.in new file mode 100644 index 0000000..cf07db5 --- /dev/null +++ b/man/oh_version.3.in @@ -0,0 +1,32 @@ +.TH oh_version 3 "@@DATE@@" "@@PACKAGE@@-@@VERSION@@" "@@DESCRIPTION@@" + +.SH NAME +oh_version - print the application version string + +.SH SYNOPSIS +.B . @@LIBDIR@@/messages +.P +.B oh_version + +.SH DESCRIPTION +.BR oh_version () +prints the application version string. + +.SH RETURN VALUE +None. + +.SH COPYRIGHT +Copyright (C) 2012 Patrick "P. J." McDermott +.P +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.P +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. +.P +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. diff --git a/man/oh_warn.3.in b/man/oh_warn.3.in new file mode 100644 index 0000000..ec0f9c6 --- /dev/null +++ b/man/oh_warn.3.in @@ -0,0 +1,42 @@ +.TH oh_warn 3 "@@DATE@@" "@@PACKAGE@@-@@VERSION@@" "@@DESCRIPTION@@" + +.SH NAME +oh_warn - print a warning message + +.SH SYNOPSIS +.B . @@LIBDIR@@/messages +.P +.B oh_warn +.I format +.RI [ argument ]... + +.SH DESCRIPTION +.BR oh_warn () +prints +.IR argument s +according to +.IR format . +.P +See +.BR printf (1) +for the syntax of +.IR format . + +.SH RETURN VALUE +None. + +.SH COPYRIGHT +Copyright (C) 2012 Patrick "P. J." McDermott +.P +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.P +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. +.P +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. |