FMX_clidefs.h File Reference

Private definitions for the FMX command line interface. More...

#include <CLI/CLI_pubdefs.h>

Functions
unsigned int	FMX_exit (CLI_Control *, void *)
	Handle the verb exit.
unsigned int	FMX_help (CLI_Control *, void *)
	Handle the verb help.
unsigned int	FMX_show (CLI_Control *, void *)
	Callback for the show command.
unsigned int	FMX_showConnect (CLI_Control *, void *)
	Display the connection.
unsigned int	FMX_showDevice (CLI_Control *, void *)
	Display the device table.
unsigned int	FMX_showFiletype (CLI_Control *, void *)
	Display the filetype table.
unsigned int	FMX_showHost (CLI_Control *, void *)
	Display the host table.
unsigned int	FMX_showKey (CLI_Control *, void *)
	List files corresponding to key (the first parameter)
unsigned int	FMX_showInstrument (CLI_Control *, void *)
	Display the instrument table.
unsigned int	FMX_showNode (CLI_Control *, void *)
	Display the node table.
unsigned int	FMX_showTag (CLI_Control *, void *)
	Display the tag table.
unsigned int	FMX_showCDM (CLI_Control *, void *)
	List files corresponding to key (the first parameter)
unsigned int	FMX_showFOF (CLI_Control *, void *)
	List members of a compound "file-of-files".
unsigned int	FMX_showSBS (CLI_Control *, void *)
	List members of a compound secondary boot script.
CLI_Syntax *	FMX_syntax (void)
	Define the FMX syntax.
Variables
const char *	s_absolute
	The string "absolute".
const char *	s_cdm
	The string "cdm".
const char *	s_compress
	The string "compress".
const char *	s_connection
	The string "connection".
const char *	s_device
	The string "device".
const char *	s_dry_run
	The string "dry-run".
const char *	s_exit
	The string "exit".
const char *	s_export
	The string "export".
const char *	s_FMX
	The string "FMX".
const char *	s_filetype
	The string "filetype".
const char *	s_fof
	The string "fof".
const char *	s_full
	The string "full".
const char *	s_help
	The string "help".
const char *	s_host
	The string "host".
const char *	s_import
	The string "import".
const char *	s_key
	The string "key".
const char *	s_instrument
	The string "instrument".
const char *	s_nickname
	The string "nickname".
const char *	s_node
	The string "node".
const char *	s_path
	The string "path".
const char *	s_sbs
	The string "sbs".
const char *	s_show
	The string "show".
const char *	s_tag
	The string "tag".
const char *	s_title
	The string "title".
const char *	s_xref
	The string "xref".
const char *	d_0
	The string "$0".

---

Detailed Description

Private definitions for the FMX command line interface.

CVS $Id: FMX_clidefs.h,v 1.3 2011/03/25 20:42:51 apw Exp $

Author:

A.P.Waite

---

Function Documentation

unsigned int FMX_exit	(	CLI_Control *	ctl,
		void *	user
	)

Handle the verb exit.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Return values:

CLI_ENDOFCMD

Always

Referenced by FMX_syntax().

unsigned int FMX_help	(	CLI_Control *	ctl,
		void *	user
	)

Handle the verb help.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

Referenced by FMX_syntax().

unsigned int FMX_show	(	CLI_Control *	ctl,
		void *	user
	)

Callback for the show command.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

A never call.

Referenced by FMX_syntax().

unsigned int FMX_showCDM	(	CLI_Control *	ctl,
		void *	user
	)

List files corresponding to key (the first parameter)

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References d_0, s_absolute, and s_tag.

Referenced by FMX_syntax().

unsigned int FMX_showConnect	(	CLI_Control *	ctl,
		void *	user
	)

Display the connection.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References FMX_printConnect().

Referenced by FMX_syntax().

unsigned int FMX_showDevice	(	CLI_Control *	ctl,
		void *	user
	)

Display the device table.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_DEVICE, FMX_OPT_TITLE, FMX_printEnumTable(), and s_title.

Referenced by FMX_syntax().

unsigned int FMX_showFiletype	(	CLI_Control *	ctl,
		void *	user
	)

Display the filetype table.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_FILETYPE, FMX_OPT_TITLE, FMX_printEnumTable(), and s_title.

Referenced by FMX_syntax().

unsigned int FMX_showFOF	(	CLI_Control *	ctl,
		void *	user
	)

List members of a compound "file-of-files".

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References d_0, FMX_cb_showFOF(), and s_export.

Referenced by FMX_syntax().

unsigned int FMX_showHost	(	CLI_Control *	ctl,
		void *	user
	)

Display the host table.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_HOST, FMX_OPT_FULL, FMX_OPT_TITLE, FMX_printEnumTable(), s_full, and s_title.

Referenced by FMX_syntax().

unsigned int FMX_showInstrument	(	CLI_Control *	ctl,
		void *	user
	)

Display the instrument table.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_INSTRUMENT, FMX_OPT_TITLE, FMX_printEnumTable(), and s_title.

Referenced by FMX_syntax().

unsigned int FMX_showKey	(	CLI_Control *	ctl,
		void *	user
	)

List files corresponding to key (the first parameter)

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References d_0, FMX_cb_showKey(), FMX_L_TAGS, FMX_OPT_EXPORT, FMX_OPT_IMPORT, _FMX_cb_showKeyPrm::ntag, _FMX_cb_showKeyPrm::opt, s_export, s_import, s_tag, and _FMX_cb_showKeyPrm::tags.

Referenced by FMX_syntax().

unsigned int FMX_showNode	(	CLI_Control *	ctl,
		void *	user
	)

Display the node table.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_NODE, FMX_OPT_TITLE, FMX_printEnumTable(), and s_title.

Referenced by FMX_syntax().

unsigned int FMX_showSBS	(	CLI_Control *	ctl,
		void *	user
	)

List members of a compound secondary boot script.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References d_0, FMX_cb_showSBS(), s_export, and s_tag.

Referenced by FMX_syntax().

unsigned int FMX_showTag	(	CLI_Control *	ctl,
		void *	user
	)

Display the tag table.

Parameters:

ctl	(in) Anonymous control pointer
user	(in) User parameter

Returns:

Status code

References FMX_ENUM_TABLE_TAG, FMX_OPT_TITLE, FMX_printEnumTable(), and s_title.

Referenced by FMX_syntax().

CLI_Syntax* FMX_syntax

(

void

)

Define the FMX syntax.

Returns:

Primary syntax pointer

References FMX_exit(), FMX_help(), FMX_show(), FMX_showCDM(), FMX_showConnect(), FMX_showDevice(), FMX_showFiletype(), FMX_showFOF(), FMX_showHost(), FMX_showInstrument(), FMX_showKey(), FMX_showNode(), FMX_showSBS(), FMX_showTag(), s_absolute, s_cdm, s_connection, s_device, s_exit, s_export, s_filetype, s_FMX, s_fof, s_full, s_help, s_host, s_import, s_instrument, s_key, s_node, s_sbs, s_show, s_tag, and s_title.

Referenced by main().