/usr/include/yuma/ncx/help.h is in libyuma-dev 2.10-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef _H_help
#define _H_help
/* FILE: help.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
Print help text for various templates
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
05-oct-07 abb Begun
*/
#include <xmlstring.h>
#ifndef _H_ncxconst
#include "ncxconst.h"
#endif
#ifndef _H_obj
#include "obj.h"
#endif
#ifndef _H_typ
#include "typ.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* C O N S T A N T S *
* *
*********************************************************************/
#define HELP_MODE_BRIEF_MAX 60
#define HELP_MODE_NORMAL_MAX 100
/********************************************************************
* *
* T Y P E S *
* *
*********************************************************************/
typedef enum help_mode_t_ {
HELP_MODE_NONE,
HELP_MODE_BRIEF,
HELP_MODE_NORMAL,
HELP_MODE_FULL
} help_mode_t;
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION help_program_module
*
* Print the full help text for an entire program module to STDOUT
*
* INPUTS:
* modname == module name without file suffix
* cliname == name of CLI parmset within the modname module
*
*********************************************************************/
extern void
help_program_module (const xmlChar *modname,
const xmlChar *cliname,
help_mode_t mode);
/********************************************************************
* FUNCTION help_data_module
*
* Print the full help text for an entire data module to STDOUT
*
* INPUTS:
* mod == data module struct
* mode == help mode requested
*********************************************************************/
extern void
help_data_module (const ncx_module_t *mod,
help_mode_t mode);
/********************************************************************
* FUNCTION help_type
*
* Print the full help text for a data type to STDOUT
*
* INPUTS:
* typ == type template struct
* mode == help mode requested
*********************************************************************/
extern void
help_type (const typ_template_t *typ,
help_mode_t mode);
/********************************************************************
* FUNCTION help_object
*
* Print the full help text for a RPC method template to STDOUT
*
* INPUTS:
* obj == object template
* mode == help mode requested
*********************************************************************/
extern void
help_object (obj_template_t *obj,
help_mode_t mode);
/********************************************************************
* FUNCTION help_write_lines
*
* write some indented output to STDOUT
*
* INPUTS:
* str == string to print; 'indent' number of spaces
* will be added to each new line
* indent == indent count
* startnl == TRUE if start with a newline, FALSE otherwise
*********************************************************************/
extern void
help_write_lines (const xmlChar *str,
uint32 indent,
boolean startnl);
/********************************************************************
* FUNCTION help_write_lines_max
*
* write some indented output to STDOUT
*
* INPUTS:
* str == string to print; 'indent' number of spaces
* will be added to each new line
* indent == indent count
* startnl == TRUE if start with a newline, FALSE otherwise
* maxlen == 0..N max number of chars to output
*********************************************************************/
extern void
help_write_lines_max (const xmlChar *str,
uint32 indent,
boolean startnl,
uint32 maxlen);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_help */
|