.\" 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_TASK_CLIENT 1p"
.TH CIPUX_TASK_CLIENT 1p "2015-09-06" "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"
command line interface to CipUX Task library
.SH "VERSION"
.IX Header "VERSION"
version 3.4.0.7
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& cipux_task_client [OPTION] \-t <TASK> \-o <OBJECT> [\-x|\-y <ATTR>=<VALUE>]
\&
\& abbreviations: ATTR = ATTRIBUTE
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
.Vb 1
\&        Options for all commands:
\&
\&        \-c | \-\-cfg             : cipux\-task.conf
\&        \-D | \-\-debug           : print debug messages for developers
\&        \-h | \-\-help            : print help (this message + options)
\&        \-V | \-\-version         : print only version
\&
\&        Options for some commands:
\&
\&        \-t | \-\-task           : CipUX::Task command
\&        \-x | \-\-mattrvalue     : multiple LDAP attributes, please see
\&                                description
\&        \-y | \-\-attrvalue      : one LDAP attribute with multible values,
\&                                please see description
.Ve
.SH "DESCRIPTION OF OPTIONS"
.IX Header "DESCRIPTION OF OPTIONS"
.IP "\fI\-\-attrvalue\fR" 4
.IX Item "--attrvalue"
This is option have to be use if a \s-1LDAP\s0 attribute of object has no possibility
to search or do not know its own equality. This attributes are rather seldom,
nisNetgroupTriple is such an attribute. It is used for clients of netgroups. If
you are not sure use \-\-mattrvalue (\-x) instaed. If you want to set a values you
should provide them like this:
.Sp
.Vb 1
\&  \-\-attrvalue <ATTRIBUTE>=<VALUE>
.Ve
.Sp
If you want to delete all values of that attribute you can just provide:
.Sp
.Vb 1
\&  \-\-attrvalue <ATTRIBUTE>
.Ve
.IP "\fI\-c\fR" 4
.IX Item "-c"
Same as option \-\-cfg.
.IP "\fI\-\-cfg\fR" 4
.IX Item "--cfg"
To specify the configuration file, if any. The default location for the
configuration file is:
.Sp
.Vb 1
\& (1) ~/.cipux/cipux\-task.yaml
.Ve
.Sp
or
.Sp
.Vb 1
\& (2) /etc/cipux/cipux\-task.yaml
.Ve
.Sp
If both are missing, you have to use this option \-\-cfg to specify one.
.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 and
see more message printed to \s-1STDOUT.\s0
.Sp
The suggestion is not to use debug output for production code.
.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\-\-mattrvalue\fR" 4
.IX Item "--mattrvalue"
This is option have to be use if a \s-1LDAP\s0 object has to be created. This option
requires always an attribute and a value. Therefore only this syntax is
possible:
.Sp
.Vb 1
\&  \-\-mattrvalue <ATTRIBUTE>=<VALUE>
.Ve
.Sp
The reason for this is to be able to gave the user exact hints when he try to
create a object but forget the value.
.Sp
The \*(L"m\*(R" stands for multiple. So it is possible to give the option several
times.
.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\-t\fR" 4
.IX Item "-t"
Same as option \-\-task.
.IP "\fI\-\-task\fR" 4
.IX Item "--task"
This option defines the \*(L"task name\*(R" the command is operating with. A \*(L"task
name\*(R" is a certain command inside the CipUX Task Library. For example
\&\*(L"cipux_task_create room\*(R". You can easily define new tasks in the configuration
file. The default location of this file is /etc/cipux/cipux\-task.yaml.
.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\-x\fR" 4
.IX Item "-x"
Same as option \-\-mattrvalue.
.IP "\fI\-y\fR" 4
.IX Item "-y"
Same as option \-\-attrvalue.
.SH "COMMANDS"
.IX Header "COMMANDS"
.Vb 1
\& cipux_task_client
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See the CipUX webpage and the manual at <http://www.cipux.org>
.PP
See the mailing list <http://sympa.cipworx.org/wws/info/cipux\-devel>
.SH "AUTHOR"
.IX Header "AUTHOR"
Christian Kuelker  <christian.kuelker@cipworx.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2007 \- 2010 by Christian Kuelker
.PP
This program is free software; you can redistribute it and/or
modify it under the terms of the \s-1GNU\s0 General Public License as
published by the Free Software Foundation; either version 2, or (at
your option) any later version.
.PP
This program is distributed in the hope that it will be useful, but
\&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE. \s0 See the \s-1GNU\s0
General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA
02111\-1307 USA\s0