|
From: Jason B. <br...@us...> - 2005-01-06 20:50:08
|
Update of /cvsroot/openxcat/openxcat/man/man3 In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7541 Added Files: Base.pm.3 Config.pm.3 Netboot.pm.3 Log Message: Add initial library man pages --- NEW FILE: Netboot.pm.3 --- .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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. | will give a .\" real vertical bar. \*(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-|\(bv\*(Tr .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" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" 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 "openXcat::Netboot 3" .TH openXcat::Netboot 3 "2004-11-05" "perl v5.8.0" "User Contributed Perl Documentation" --- NEW FILE: Config.pm.3 --- .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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. | will give a .\" real vertical bar. \*(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-|\(bv\*(Tr .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" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" 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 "openXcat::Config 3" .TH openXcat::Config 3 "2004-11-16" "perl v5.8.0" "User Contributed Perl Documentation" .SH "NAME" openXcat::Config \- Parses and returns configuration information from oXc config files .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use openXcat::Base; \& use openXcat::Config; \& my %configinfo = getconfigfile( $configfile ) .Ve .PP .Vb 1 \& my @option1opts = @{ $configinfo{'option1'} }; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module reads a given config file that has been written in the format that other oXc config files are written. For example: .PP .Vb 2 \& option value \& option2 val1,val2,val3 .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" Look within each config file for more information on how to format the data See openXcat::Base for more information on how to deal with config values .SH "AUTHOR" .IX Header "AUTHOR" Jason Brechin <br...@nc...> .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2004, The Board of Trustees of the University of Illinois .PP Free software bound by \s-1GPL\s0 license --- NEW FILE: Base.pm.3 --- .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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. | will give a .\" real vertical bar. \*(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-|\(bv\*(Tr .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" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" 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 "openXcat::Base 3" .TH openXcat::Base 3 "2004-12-01" "perl v5.8.0" "User Contributed Perl Documentation" .SH "NAME" openXcat::Base \- Provides basic information for oXc Perl programs .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use openXcat::Base; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides variables and functions that many oXc programs may need. .Sh "Variables" .IX Subsection "Variables" .ie n .IP "$RSHC" 8 .el .IP "\f(CW$RSHC\fR" 8 .IX Item "$RSHC" Contains path to remote shell command, usually \f(CW\*(C`/usr/bin/ssh\*(C'\fR .ie n .IP "$ROOT" 8 .el .IP "\f(CW$ROOT\fR" 8 .IX Item "$ROOT" Contains path to openXcat root, usually \f(CW\*(C`/opt/openxcat\*(C'\fR or something similar .ie n .IP "$ARCH" 8 .el .IP "\f(CW$ARCH\fR" 8 .IX Item "$ARCH" Contains architecture, as obtained from uname .ie n .IP "%TABS" 8 .el .IP "\f(CW%TABS\fR" 8 .IX Item "%TABS" Hash containing the locations of the .tab files. To access the information, you reference them as follows: .Sp \&\f(CW\*(C`my $nodelistloc = $TABS{'NODELIST'};\*(C'\fR .ie n .IP "%sitetabconf" 8 .el .IP "\f(CW%sitetabconf\fR" 8 .IX Item "%sitetabconf" Hash containing values in site.tab. Useful for gathering various pieces of information using getvalue .ie n .IP "@uname" 8 .el .IP "\f(CW@uname\fR" 8 .IX Item "@uname" Array of values returned from uname. See uname for more information. .ie n .IP "$hostname" 8 .el .IP "\f(CW$hostname\fR" 8 .IX Item "$hostname" Contains name of current host. .Sh "Methods" .IX Subsection "Methods" .ie n .IP """singlenodeeg""" 8 .el .IP "\f(CWsinglenodeeg\fR" 8 .IX Item "singlenodeeg" Gives a single example node .ie n .IP """version""" 8 .el .IP "\f(CWversion\fR" 8 .IX Item "version" Returns the openXcat version .ie n .IP """osver""" 8 .el .IP "\f(CWosver\fR" 8 .IX Item "osver" Returns the \s-1OS\s0 version as a string .ie n .IP """interface2ip""" 8 .el .IP "\f(CWinterface2ip\fR" 8 .IX Item "interface2ip" Gives the \s-1IP\s0 for a given interface. It returns the ip addr, broadcast, and netmask of an interface. .Sp This function was originally written by Sean Dague, distributed as part of \s-1OSCAR\s0 in OSCAR::Network under the \s-1GPL\s0 license. .ie n .IP """host2ip""" 8 .el .IP "\f(CWhost2ip\fR" 8 .IX Item "host2ip" Resolves a hostname to an \s-1IP\s0 .ie n .IP """getinterfaces""" 8 .el .IP "\f(CWgetinterfaces\fR" 8 .IX Item "getinterfaces" Finds all network interfaces .ie n .IP """noderange""" 8 .el .IP "\f(CWnoderange\fR" 8 .IX Item "noderange" Resolves a given noderange, returns an array of node names .ie n .IP """iptohex""" 8 .el .IP "\f(CWiptohex\fR" 8 .IX Item "iptohex" Transforms a dotted decimal \s-1IP\s0 to a packed hexadecimal .ie n .IP """hextoip""" 8 .el .IP "\f(CWhextoip\fR" 8 .IX Item "hextoip" Transforms a packed hexadecimal \s-1IP\s0 to dotted decimal .ie n .IP """intersection""" 8 .el .IP "\f(CWintersection\fR" 8 .IX Item "intersection" Really a sort of \f(CW\*(C`uniq\*(C'\fR function, gets rid of duplicate entries .ie n .IP """genpasswd""" 8 .el .IP "\f(CWgenpasswd\fR" 8 .IX Item "genpasswd" Generates a random password of any length (default: 8) .ie n .IP """getvalue""" 8 .el .IP "\f(CWgetvalue\fR" 8 .IX Item "getvalue" Useful in getting values from %sitetabconf or other hashes .ie n .IP """pbsusernodes""" 8 .el .IP "\f(CWpbsusernodes\fR" 8 .IX Item "pbsusernodes" Returns all nodes assigned to a particular user in \s-1PBS\s0 .ie n .IP """pbsjobnodes""" 8 .el .IP "\f(CWpbsjobnodes\fR" 8 .IX Item "pbsjobnodes" Returns all nodes assigned to a particular job \s-1ID\s0 in \s-1PBS\s0 .ie n .IP """ping""" 8 .el .IP "\f(CWping\fR" 8 .IX Item "ping" Pings a list of nodes .ie n .IP """nodehash""" 8 .el .IP "\f(CWnodehash\fR" 8 .IX Item "nodehash" Returns two references to hashes, one with node keys, one with group keys .ie n .IP """phm""" 8 .el .IP "\f(CWphm\fR" 8 .IX Item "phm" Pass in a function name and a noderange, it returns an array with the method by which that node supports that function (e.g. node1 uses ipmi for power) .SH "SEE ALSO" .IX Header "SEE ALSO" See http://www.sourceforge.net/projects/openxcat for more information .SH "AUTHOR" .IX Header "AUTHOR" Jason Brechin <br...@nc...> .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2004, The Board of Trustees of the University of Illinois .PP Free software bound by \s-1GPL\s0 license |