.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CIPUX_CAT_WEB_MODULE 1p"
.TH CIPUX_CAT_WEB_MODULE 1p "2015-07-23" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Program to register, deregister and list a CAT modules.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& (1) cipux_cat_web_module [OPTIONS] \-\-register \-\-object <NAME>| \-\-all
\&
\& (2) cipux_cat_web_module [OPTIONS] \-\-deregister \-\-object <NAME>| \-\-all
\&
\& (3) cipux_cat_web_module [OPTIONS] \-\-list\-registered
\&
\& (4) cipux_cat_web_module [OPTIONS] \-\-list\-deregistered
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
.Vb 7
\&        Options for all commands:
\&        \-D | \-\-debug         : print debug messages for developers
\&        \-h | \-\-help          : print help (this message + options)
\&        \-l | \-\-login ID      : uses ID as UID to authenticate
\&        \-V | \-\-version       : print only version
\&             \-\-verbose       : print more messages
\&        \-w | \-\-password CRED : uses CRED as credential to authenticate
\&
\&        Additional options for registering and deregistering:
\&        \-a | \-\-all     : (de)register all pending objects
\&
\&        Additional options for registering:
\&        \-e | \-\-enable     : enable module(s)
\&        \-m | \-\-add\-member : add object (user or group) to ACL
.Ve
.SH "USAGE SPECIFIC OPTIONS"
.IX Header "USAGE SPECIFIC OPTIONS"
(1) register
.PP
.Vb 3
\& \-\-add\-member <NAME>  : do add object to the ACL, so that this object
\&                        can access the modules. An object could be a
\&                        group or a user.
\&
\& \-e | \-\-enable        : do enable the module during registration; module is
\&                        disabled by default
\&
\& \-a | \-\-all           : register all modules
\& or
\& \-o | \-\-object <NAME> : or register only one module
.Ve
.PP
(2) deregister
.PP
.Vb 3
\& \-a | \-\-all           : deregister all modules
\& or
\& \-o | \-\-object <NAME> : or deregister only one module
.Ve
.PP
The \s-1URL\s0 of the CipUX XML-RPC server is taken from cipux\-cat\-web.ini file. The
default location for CipUX-CAT-Web. If you would like to use a different \s-1URL\s0
change catweb_rpc_server in the base section.
.SH "DESCRIPTION OF OPTIONS"
.IX Header "DESCRIPTION OF OPTIONS"
.IP "\fI\-a\fR" 4
.IX Item "-a"
Same as option \-\-all
.IP "\fI\-add\-member \s-1NAME\s0\fR" 4
.IX Item "-add-member NAME"
Adds \s-1NAME\s0 to the \s-1ACL\s0 of that module(s).
.IP "\fI\-all\fR" 4
.IX Item "-all"
Register all \s-1CAT\s0 modules.
.IP "\fI\-D\fR" 4
.IX Item "-D"
Same as option \-\-debug.
.IP "\fI\-\-debug\fR" 4
.IX Item "--debug"
To see more output, what the internals is doing, you can enable the \-\-debug
option and see more message printed to \s-1STDOUT.\s0
.IP "\fI\-e\fR" 4
.IX Item "-e"
Same as option \-\-enable.
.IP "\fI\-\-enable\fR" 4
.IX Item "--enable"
Enable the object during registration.
.IP "\fI\-h\fR" 4
.IX Item "-h"
Same as option \-\-help
.IP "\fI\-\-help\fR" 4
.IX Item "--help"
Prints brief help message.
.IP "\fI\-l \s-1UID\s0\fR" 4
.IX Item "-l UID"
Same as option \-\-login \s-1UID.\s0
.IP "\fI\-\-login \s-1UID\s0\fR" 4
.IX Item "--login UID"
Use \s-1UID\s0 as identity to authenticate against \s-1RPC\s0 server.
.IP "\fI\-o\fR" 4
.IX Item "-o"
Same as option \-\-object
.IP "\fI\-\-object\fR" 4
.IX Item "--object"
This option is used to specify the object on which the command is operating.
Make sure you choose the right object. Of course this will also fail when the
object is not fetchable with (in the objects list of) \-\-task.
.IP "\fI\-\-password \s-1SECRET\s0\fR" 4
.IX Item "--password SECRET"
Use \s-1SECRET\s0 as credential to authenticate against \s-1RPC\s0 server.
.IP "\fI\-V\fR" 4
.IX Item "-V"
Same as option \-\-version.
.IP "\fI\-\-version\fR" 4
.IX Item "--version"
Prints the version and exits.
.IP "\fI\-\-verbose\fR" 4
.IX Item "--verbose"
Not implemented yet.
.IP "\fI\-v\fR" 4
.IX Item "-v"
Same as option \-\-verbose.
.IP "\fI\-w \s-1SECRET\s0\fR" 4
.IX Item "-w SECRET"
Same as option \-\-password \s-1SECRET.\s0