.\" 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_OBJECT_CLIENT 1p" .TH CIPUX_OBJECT_CLIENT 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" cipux_object_client \- create, destroy CipUX objects .SH "VERSION" .IX Header "VERSION" version 3.4.0.3 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& cipux_object_client [OPTIONS] \-a \& \& cipux_object_client [OPTIONS] \-a list \& cipux_object_client [OPTIONS] \-a create \-t \-o \& cipux_object_client [OPTIONS] \-a destroy \-t \-o .Ve .SH "OPTIONS" .IX Header "OPTIONS" .Vb 7 \& \-c | \-\-cfg : cipux\-object.conf \& \-D | \-\-debug [] : print debug messages for developers \& \-h | \-\-help : print help (this message + options) \& \-l | \-\-list : lists configuration scopes \& \-p | \-\-pretty : nice boxed output \& \-V | \-\-version : print only version \& \-\-verbose : print more messages .Ve .SH "USAGE" .IX Header "USAGE" .Vb 1 \& cipux_object_client [OPTIONS] \-l : lists CipUX objects \& \& cipux_object_client [OPTIONS] \-h : help page \& \& cipux_object_client [OPTIONS] \-V : prints version .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\s-1TODO\s0 .SH "REQUIRED ARGUMENTS" .IX Header "REQUIRED ARGUMENTS" One of \-l or \-h or \-V is required. .SH "ARGUMENTS" .IX Header "ARGUMENTS" .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 preset location for the configuration file is: .Sp .Vb 1 \& (1) ~/.cipux/cipux\-object.conf .Ve .Sp or .Sp .Vb 1 \& (2) /etc/cipux/cipux\-object.conf .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 messages printed to \s-1STDOUT.\s0 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 "\fB\-l\fR" 4 .IX Item "-l" Same as option \-\-list .IP "\fI\-\-list\fR" 4 .IX Item "--list" Lists all object scopes. The object scopes are read from the configuration file. The preset location of the configuration file is /etc/cipux/cipux\-storage\-structure.conf. One object type is needed for the \&\-\-type option. .Sp Prints a list of configuration types to \s-1STDOUT.\s0 No object will be changed. This is useful if (1) you would like to see what kind of objects this layer can handle and (2) if you would like to test the preset or another object layer configuration file. You can use this with all other options, they will be ignored except \-p | \-pretty or \-D | \-\-debug. .Sp Example: .Sp .Vb 1 \& cipux_object_client \-l \-p \& \& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ \& | type | \& +=======================+ \& | cipux_account | \& | cipux_share | \& | cipux_room | \& | cipux_configuration | \& | cipux_machines | \& | netgroup | \& | cipux_room | \& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ .Ve .IP "\fI\-p\fR" 4 .IX Item "-p" Same as option \-\-pretty. .IP "\fI\-\-pretty\fR" 4 .IX Item "--pretty" On command which produce an output, this option can be used to draw a fancy box around the output. .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 jet. .IP "\fI\-v\fR" 4 .IX Item "-v" Same as option \-\-verbose. .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" \&\s-1TODO\s0 .SH "EXIT STATUS" .IX Header "EXIT STATUS" \&\s-1TODO\s0 .SH "CONFIGURATION" .IX Header "CONFIGURATION" \&\s-1TODO\s0 .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" Carp CipUX::Object::Client version .SH "INCOMPATIBILITIES" .IX Header "INCOMPATIBILITIES" Not known. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" Not known. .SH "SEE ALSO" .IX Header "SEE ALSO" See the CipUX web page and the manual at .PP See the mailing list .SH "AUTHOR" .IX Header "AUTHOR" Christian Kuelker .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright (C) 2007 \- 2009 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 .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" \&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0 .PP \&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE \s0(\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\s0