.\" 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::Dog 3pm"
.TH CipUX::Dog 3pm "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::Dog \- Adds a hook to CipUX::Task to execute commands.
.SH "VERSION"
.IX Header "VERSION"
This document describes CipUX::Dog version 3.4.0.0
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&   use CipUX::Dog;
.Ve
.PP
or
.PP
.Vb 1
\& use English qw( \-no_match_vars);
\&
\& eval { require CipUX::Dog; };
\&
\& if ( not $EVAL_ERROR ) {
\&
\&     my $dog = CipUX::Dog\->new(
\&        {
\&             dog_hr       => $dog_hr,
\&             object       => $object,
\&             overwrite_hr => $overwrite_hr,
\&         }
\&     );
\&
\&     $dog\->bite();    # exec files system command
\&
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
CipuX::Dog can be used as a hook for CipUX::Task. If CipUX::Dog is installed
it can be configured by the administrator to execute commands triggered by
execution of a given task.
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
.SS "\s-1BUILD\s0"
.IX Subsection "BUILD"
Create the Object, reads the config file
.SS "\s-1DEMOLISH\s0"
.IX Subsection "DEMOLISH"
Removes the object
.SS "bite"
.IX Subsection "bite"
Calls the dog to bite.
.SS "execute"
.IX Subsection "execute"
Execute a command.
.PP
.Vb 2
\& my $return = $self\->execute(
\&     { command => $self\->l($cmd), cmdargs_ar => $cmd_args_ar } );
.Ve
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
This section list every single error and warning message that the module can
generate (even the ones that will \*(L"never happen\*(R"), with a full explanation of
each problem, one or more likely causes, and any suggested remedies.
.ie n .IP """The section ""commands"" is not defined in cipux\-dog.perl for %s""" 4
.el .IP "\f(CWThe section ``commands'' is not defined in cipux\-dog.perl for %s\fR" 4
.IX Item "The section ""commands"" is not defined in cipux-dog.perl for %s"
The hash key 'commands' is not inside the configuration for a given dog hash
key in cipux\-dog.perl configuration. The problem might look like this:
.Sp
.Vb 6
\& $cfg = {
\&     cipux_dogs => {
\&         create_homedir => {
\&         },
\&     },
\& };
.Ve
.Sp
It can be solved by adding a 'commands' key:
.Sp
.Vb 8
\& $cfg = {
\&     cipux_dogs => {
\&         create_homedir => {
\&             commands => {
\&             },
\&         },
\&     },
\& };
.Ve
.ie n .IP """Cannot execute [%s]. Please provide this command or change [cipux\-dog.perl]. The error message was: %s""" 4
.el .IP "\f(CWCannot execute [%s]. Please provide this command or change [cipux\-dog.perl]. The error message was: %s\fR" 4
.IX Item "Cannot execute [%s]. Please provide this command or change [cipux-dog.perl]. The error message was: %s"
There can be different reasons for this message. It depends on the last \f(CW%s\fR.
The following reasons are foreseen:
.Sp
\&\f(CW\*(C`Command do not exist!\*(C'\fR
.Sp
The command specified in cipux\-dog.perl do not exist. You should copy,
provide or write this command.
.Sp
\&\f(CW\*(C`Command is not executable! (forget chmod +x ?)\*(C'\fR
.Sp
The command specified in cipux\-dog.perl exists but can not be executed.
Either it has no executable flags or you have not the right to execute it.
Check and/ro set the execution bit on this command or try do give you the
right to execute it.
.Sp
\&\f(CW\*(C`?\*(C'\fR
.Sp
Other reasons not be able to execute the command might come from the system
and will display after the message.
.ie n .IP """Can not close command %s""" 4
.el .IP "\f(CWCan not close command %s\fR" 4
.IX Item "Can not close command %s"
If the file handle can not be closed this message will be displayed.
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
CipUX::Dog requires a configuration file but no environment variables. It can
be configured by cipux\-dog.$ext, where \f(CW$ext\fR is a valid and capable extension
from CipUX configuration space. The default configuration for CipUX::Dog is
in: /usr/share/cipux/etc/cipux\-dog.perl
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
Carp
CipUX
Class::Std
Data::Dumper
English
Log::Log4perl
Readonly
version
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None reported.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
No bugs have been reported.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See the CipUX webpage and the manual at <http://www.cipux.org>
.SH "AUTHOR"
.IX Header "AUTHOR"
Christian Kuelker  \f(CW\*(C`<christian.kuelker@cipworx.org>\*(C'\fR
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (C) 2008 \- 2009, Christian Kuelker. All rights reserved.
.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 LICENSE, 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