YANG help text support for CLI Print help text for various templates. More...

#include <xmlstring.h>
#include "ncxconst.h"
#include "obj.h"
#include "typ.h"

Include dependency graph for help.h:

This graph shows which files directly or indirectly include this file:

Enumerations
enum	help_mode_t { HELP_MODE_NONE , HELP_MODE_BRIEF , HELP_MODE_NORMAL , HELP_MODE_FULL }
	modes to match the keywords brief, normal, full More...

Functions
void	help_program_module (const xmlChar modname, const xmlChar cliname, help_mode_t mode)
	Print the full help text for an entire program module to STDOUT. More...

void	help_data_module (const ncx_module_t *mod, help_mode_t mode)
	Print the full help text for an entire data module to STDOUT. More...

void	help_type (const typ_template_t *typ, help_mode_t mode)
	Print the full help text for a YANG data type to STDOUT. More...

void	help_object (obj_template_t *obj, help_mode_t mode)
	Print the full help text for an object template to STDOUT. More...

void	help_write_lines (const xmlChar *str, uint32 indent, boolean startnl)
	write some indented output to STDOUT More...

void	help_write_lines_max (const xmlChar *str, uint32 indent, boolean startnl, uint32 maxlen)
	write some indented output to STDOUT More...

help_mode_t	help_cvt_str (const xmlChar *str)
	Convert a string to a help_mode_t enum. More...

const xmlChar *	help_cvt_enum (help_mode_t mode)
	Convert a help_mode_t enum to a string. More...

Detailed Description

YANG help text support for CLI Print help text for various templates.

Enumerations