NAME
Config::Model::TermUI - Provides Config::Model UI à la Term::ReadLine
SYNOPSIS
my $model = Config::Model -> new ;
my $inst = $model->instance (root_class_name => 'RootClass',
instance_name => 'my_instance');
my $root = $inst -> config_root ;
my $term_ui = Config::Model::TermUI->new( root => $root ,
title => 'My Title',
prompt => 'My Prompt',
);
# engage in user interaction
$term_ui -> run_loop ;
DESCRIPTION
This module provides a helper to construct pure ascii user interface on top of Term::ReadLine.
USER COMMAND SYNTAX
- cd ...
-
Jump into node or value element. You can use
cd <element>
,cd <elt:key>
orcd -
to go up one node orcd !
to go to configuration root. - set elt=value, elt:key=value
-
Set a value.
- display elt elt:key
-
Display a value
- ls
-
Show elements of current node
- help
-
Show available commands.
- desc[ription]
-
Show class description of current node.
- desc(elt)
-
Show description of element from current node.
- desc(value)
-
Show effect of value (for enum)
CONSTRUCTOR
parameters
- root
-
Root node of the configuration tree
- title
-
UI title
- prompt
-
UI prompt. The prompt will be completed with the location of the current node.
Methods
run_loop()
Engage in user interaction until user enters '^D' (CTRL-D).
BUGS
Auto-completion is not complete.
AUTHOR
Dominique Dumont, domi@komarr.grenoble.hp.com
SEE ALSO
Config::Model, Config::Model::Instance, Config::Model::Node,
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 38:
Non-ASCII character seen before =encoding in 'à'. Assuming CP1252