1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "AppConfig::Sys 3"
132 .TH AppConfig::Sys 3 "2007-05-30" "perl v5.8.7" "User Contributed Perl Documentation"
134 AppConfig::Sys \- Perl5 module defining platform\-specific information and methods for other AppConfig::* modules.
136 .IX Header "SYNOPSIS"
138 \& use AppConfig::Sys;
139 \& my $sys = AppConfig::Sys\->new();
143 \& @fields = $sys\->getpwuid($userid);
144 \& @fields = $sys\->getpwnam($username);
147 .IX Header "OVERVIEW"
148 AppConfig::Sys is a Perl5 module provides platform-specific information and
149 operations as required by other AppConfig::* modules.
151 AppConfig::Sys is distributed as part of the AppConfig bundle.
153 .IX Header "DESCRIPTION"
154 .Sh "\s-1USING\s0 \s-1THE\s0 AppConfig::Sys \s-1MODULE\s0"
155 .IX Subsection "USING THE AppConfig::Sys MODULE"
156 To import and use the AppConfig::Sys module the following line should
157 appear in your Perl script:
160 \& use AppConfig::Sys;
163 AppConfig::Sys is implemented using object-oriented methods. A new
164 AppConfig::Sys object is created and initialised using the
165 AppConfig::Sys\->\fInew()\fR method. This returns a reference to a new
166 AppConfig::Sys object.
169 \& my $sys = AppConfig::Sys\->new();
172 This will attempt to detect your operating system and create a reference to
173 a new AppConfig::Sys object that is applicable to your platform. You may
174 explicitly specify an operating system name to override this automatic
178 \& $unix_sys = AppConfig::Sys\->new("Unix");
181 Alternatively, the package variable \f(CW$AppConfig::Sys::OS\fR can be set to an
182 operating system name. The valid operating system names are: Win32, \s-1VMS\s0,
183 Mac, \s-1OS2\s0 and Unix. They are not case\-specific.
184 .Sh "AppConfig::Sys \s-1METHODS\s0"
185 .IX Subsection "AppConfig::Sys METHODS"
186 AppConfig::Sys defines the following methods:
187 .IP "\fIgetpwnam()\fR" 4
188 .IX Item "getpwnam()"
189 Calls the system function \fIgetpwnam()\fR if available and returns the result.
190 Returns undef if not available. The \fIcan_getpwnam()\fR method can be called to
191 determine if this function is available.
192 .IP "\fIgetpwuid()\fR" 4
193 .IX Item "getpwuid()"
194 Calls the system function \fIgetpwuid()\fR if available and returns the result.
195 Returns undef if not available. The \fIcan_getpwuid()\fR method can be called to
196 determine if this function is available.
200 Andy Wardley, <abw@wardley.org>
202 .IX Header "COPYRIGHT"
203 Copyright (C) 1997\-2007 Andy Wardley. All Rights Reserved.
205 Copyright (C) 1997,1998 Canon Research Centre Europe Ltd.
207 This module is free software; you can redistribute it and/or modify it under
208 the term of the Perl Artistic License.
210 .IX Header "SEE ALSO"
211 AppConfig, AppConfig::File