1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/openpkg/register.8 Tue Jul 31 12:23:42 2012 +0200
1.3 @@ -0,0 +1,441 @@
1.4 +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
1.5 +.\"
1.6 +.\" Standard preamble:
1.7 +.\" ========================================================================
1.8 +.de Sp \" Vertical space (when we can't use .PP)
1.9 +.if t .sp .5v
1.10 +.if n .sp
1.11 +..
1.12 +.de Vb \" Begin verbatim text
1.13 +.ft CW
1.14 +.nf
1.15 +.ne \\$1
1.16 +..
1.17 +.de Ve \" End verbatim text
1.18 +.ft R
1.19 +.fi
1.20 +..
1.21 +.\" Set up some character translations and predefined strings. \*(-- will
1.22 +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
1.23 +.\" double quote, and \*(R" will give a right double quote. \*(C+ will
1.24 +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
1.25 +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
1.26 +.\" nothing in troff, for use with C<>.
1.27 +.tr \(*W-
1.28 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
1.29 +.ie n \{\
1.30 +. ds -- \(*W-
1.31 +. ds PI pi
1.32 +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
1.33 +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
1.34 +. ds L" ""
1.35 +. ds R" ""
1.36 +. ds C`
1.37 +. ds C'
1.38 +'br\}
1.39 +.el\{\
1.40 +. ds -- \|\(em\|
1.41 +. ds PI \(*p
1.42 +. ds L" ``
1.43 +. ds R" ''
1.44 +'br\}
1.45 +.\"
1.46 +.\" Escape single quotes in literal strings from groff's Unicode transform.
1.47 +.ie \n(.g .ds Aq \(aq
1.48 +.el .ds Aq '
1.49 +.\"
1.50 +.\" If the F register is turned on, we'll generate index entries on stderr for
1.51 +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
1.52 +.\" entries marked with X<> in POD. Of course, you'll have to process the
1.53 +.\" output yourself in some meaningful fashion.
1.54 +.ie \nF \{\
1.55 +. de IX
1.56 +. tm Index:\\$1\t\\n%\t"\\$2"
1.57 +..
1.58 +. nr % 0
1.59 +. rr F
1.60 +.\}
1.61 +.el \{\
1.62 +. de IX
1.63 +..
1.64 +.\}
1.65 +.\"
1.66 +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
1.67 +.\" Fear. Run. Save yourself. No user-serviceable parts.
1.68 +. \" fudge factors for nroff and troff
1.69 +.if n \{\
1.70 +. ds #H 0
1.71 +. ds #V .8m
1.72 +. ds #F .3m
1.73 +. ds #[ \f1
1.74 +. ds #] \fP
1.75 +.\}
1.76 +.if t \{\
1.77 +. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
1.78 +. ds #V .6m
1.79 +. ds #F 0
1.80 +. ds #[ \&
1.81 +. ds #] \&
1.82 +.\}
1.83 +. \" simple accents for nroff and troff
1.84 +.if n \{\
1.85 +. ds ' \&
1.86 +. ds ` \&
1.87 +. ds ^ \&
1.88 +. ds , \&
1.89 +. ds ~ ~
1.90 +. ds /
1.91 +.\}
1.92 +.if t \{\
1.93 +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
1.94 +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
1.95 +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
1.96 +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
1.97 +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
1.98 +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
1.99 +.\}
1.100 +. \" troff and (daisy-wheel) nroff accents
1.101 +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
1.102 +.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
1.103 +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
1.104 +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
1.105 +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
1.106 +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
1.107 +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
1.108 +.ds ae a\h'-(\w'a'u*4/10)'e
1.109 +.ds Ae A\h'-(\w'A'u*4/10)'E
1.110 +. \" corrections for vroff
1.111 +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
1.112 +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
1.113 +. \" for low resolution devices (crt and lpr)
1.114 +.if \n(.H>23 .if \n(.V>19 \
1.115 +\{\
1.116 +. ds : e
1.117 +. ds 8 ss
1.118 +. ds o a
1.119 +. ds d- d\h'-1'\(ga
1.120 +. ds D- D\h'-1'\(hy
1.121 +. ds th \o'bp'
1.122 +. ds Th \o'LP'
1.123 +. ds ae ae
1.124 +. ds Ae AE
1.125 +.\}
1.126 +.rm #[ #] #H #V #F C
1.127 +.\" ========================================================================
1.128 +.\"
1.129 +.IX Title "REGISTER 8"
1.130 +.TH REGISTER 8 "OpenPKG" "REGISTER(8)" "OpenPKG"
1.131 +.\" For nroff, turn off justification. Always turn off hyphenation; it makes
1.132 +.\" way too many mistakes in technical documents.
1.133 +.if n .ad l
1.134 +.nh
1.135 +.SH "NAME"
1.136 +openpkg register \- OpenPKG Registry Command\-Line Client
1.137 +.SH "SYNOPSIS"
1.138 +.IX Header "SYNOPSIS"
1.139 +\&\fBregister\fR [\-u|\-\-user=<user|token>] [\-l|\-\-link=<token>] [\fI\-d|\-\-desc=<text\fR>]
1.140 + [\-m|\-\-mode=fake|post|wipe] [\fI\-a|\-\-args=<args\fR>]
1.141 + [\fI\-\-plat=<text\fR>] [\fI\-\-orel=<text\fR>] [\fI\-\-uuid=<file\fR>]
1.142 + [\fI\-\-conf=<file\fR>] [\fI\-\-prep=<file\fR>] [\fI\-\-tran=<file\fR>]
1.143 + [\fI\-\-util=<file\fR>] [\-\-data=<tag>[,<tag>...]]
1.144 + [\fI\-P|\-\-preparation\fR] [\fI\-T|\-\-transaction\fR]
1.145 + [\fI\-U|\-\-utilization\fR] [\fI\-C|\-\-convenience\fR]
1.146 + [\fI\-I|\-\-interaction\fR]
1.147 + [\fI\-v|\-\-verbose\fR] [\fI\-h|\-\-help\fR]
1.148 +.PP
1.149 +\&\fBregister\fR \-S|\-\-printstatus
1.150 +.PP
1.151 +\&\fBregister\fR \-R|\-\-rewriteurls [\fIurl\fR ...]
1.152 +.SH "DESCRIPTION"
1.153 +.IX Header "DESCRIPTION"
1.154 +\&\fBopenpkg register\fR is the Command-Line Client the OpenPKG Registry. It is
1.155 +used by administrators to register an instance with the OpenPKG Registry for
1.156 +later association.
1.157 +.PP
1.158 +After association, \fBopenpkg register\fR can be used for repetitive
1.159 +reregistrations which update the heartbeat of the instance on the Registry
1.160 +server, avoiding premature depature from the database. It is assumed that
1.161 +every instance will be reregistered daily. Dormant
1.162 +instances might be discarded from the Registry, revoking their access to
1.163 +additional resources.
1.164 +.SH "PRIMARY OPERATIONS"
1.165 +.IX Header "PRIMARY OPERATIONS"
1.166 +The following primary operations are available:
1.167 +.IP "\fB\-h\fR, \fB\-\-help\fR" 4
1.168 +.IX Item "-h, --help"
1.169 +Display brief usage message.
1.170 +.IP "\fB\-v\fR, \fB\-\-verbose\fR" 4
1.171 +.IX Item "-v, --verbose"
1.172 +Display progress information during data posting.
1.173 +.IP "\fB\-P\fR, \fB\-\-preparation\fR" 4
1.174 +.IX Item "-P, --preparation"
1.175 +Execute the primary operation \*(L"preparation\*(R".
1.176 +Creates registry data for one request and dumps it stdout
1.177 +in \s-1XML\s0 format. That request can be filtered and piped into
1.178 +the transaction phase or it can be copied and pasted into the
1.179 +XMLdump \s-1CGI\s0 facility manually.
1.180 +A copy of the output of the last run is also saved to the \f(CW\*(C`${REGISTRY_PREP}\*(C'\fR file.
1.181 +.IP "\fB\-T\fR, \fB\-\-transaction\fR" 4
1.182 +.IX Item "-T, --transaction"
1.183 +Execute the primary operation \*(L"transaction\*(R".
1.184 +Reads registry data with one request from stdin, executes
1.185 +the transaction and writes registry data with one or more
1.186 +responses to stdout in \s-1XML\s0 format.
1.187 +Depending on the mode of operation, the transaction might be an actual
1.188 +transport to the XMLdump \s-1CGI\s0 facility or a fake activity which complements the
1.189 +manual preparation.
1.190 +A copy of the output of the last run is also saved to the \f(CW\*(C`${REGISTRY_TRAN}\*(C'\fR file.
1.191 +.IP "\fB\-U\fR, \fB\-\-utilization\fR" 4
1.192 +.IX Item "-U, --utilization"
1.193 +Execute the primary operation \*(L"utilization\*(R".
1.194 +Reads registry data with one response from stdin and updates the local
1.195 +registry information.
1.196 +Depending on the mode of operation, the utilization might be an actual
1.197 +processing of a transaction response or a fake activity which complements the
1.198 +manual transaction.
1.199 +Anyway, this step finalizes the registration process and makes the instance
1.200 +assume it has been properly registered. This status can be printed. \s-1URL\s0
1.201 +rewriting is activated.
1.202 +A copy of the output of the last run is also saved to the \f(CW\*(C`${REGISTRY_UTIL}\*(C'\fR file.
1.203 +.IP "\fB\-C\fR, \fB\-\-convenience\fR" 4
1.204 +.IX Item "-C, --convenience"
1.205 +Execute the primary operation \*(L"convenience\*(R".
1.206 +This executes the three primary operations \*(L"preparation\*(R", \*(L"transaction\*(R" and
1.207 +\&\*(L"utilization\*(R" in that order and pipes data through this chain.
1.208 +.IP "\fB\-I\fR, \fB\-\-interaction\fR" 4
1.209 +.IX Item "-I, --interaction"
1.210 +Execute the primary operation \*(L"interaction\*(R".
1.211 +Like \*(L"convenience\*(R" but user is interactively asked for information. This is
1.212 +the easiest way to do registration but it is not meat to be automated.
1.213 +.IP "\fB\-S\fR, \fB\-\-printstatus\fR" 4
1.214 +.IX Item "-S, --printstatus"
1.215 +If the instance has been registered, information about the registration is printed in a
1.216 +format suitable for shell evaluation and return code is true.
1.217 +Otherwise nothing is printed and return code is false.
1.218 +.IP "\fB\-R\fR, \fB\-\-rewriteurls\fR [\fIurl\fR ...]" 4
1.219 +.IX Item "-R, --rewriteurls [url ...]"
1.220 +If the instance has been registered, the given URLs are rewritten to prepend
1.221 +user:pass information before hostnames below the openpkg.(org|net|com)
1.222 +domains. Note the username is is \s-1UUID_REGISTRY\s0 and the password is the
1.223 +concatenation of \s-1UUID_INSTANCE\s0 and \s-1UUID_PLATFORM\s0 from the
1.224 +PREFIX/etc/openpkg/uuid file. Both informations are not meant to be used for
1.225 +traditional authentication, they are merly statistical information.
1.226 +Otherwise the URLs are returned verbatim.
1.227 +.SH "STANDARD OPTIONS"
1.228 +.IX Header "STANDARD OPTIONS"
1.229 +Standard options are typically used to automate registration (not
1.230 +association).
1.231 +.IP "\fB\-m\fR, \fB\-\-mode\fR fake|post|wipe" 4
1.232 +.IX Item "-m, --mode fake|post|wipe"
1.233 +Overrides \f(CW\*(C`${REGISTRY_MODE}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.234 +Has no default and is a manadatory setting.
1.235 +.Sp
1.236 +In \fBpost\fR mode, transactions are carried out using real network connectivity.
1.237 +The \*(L"preparation\*(R" step creates a XMLdump and writes it into the
1.238 +\&\f(CW\*(C`${REGISTRY_PREP}\*(C'\fR file. The \*(L"transaction\*(R" step posts it to the DropXML form
1.239 +using a \s-1HTTP\s0 request. The response coming back from Registration server is
1.240 +also in \s-1XML\s0 format and is saved to \f(CW\*(C`${REGISTRY_TRAN}\*(C'\fR file. The
1.241 +\&\*(L"utilization\*(R" step processes this response and writes the final results to the
1.242 +\&\f(CW\*(C`${REGISTRY_UTIL}\*(C'\fR file.
1.243 +.Sp
1.244 +In \fBfake\fR mode, no network connectivity takes place.
1.245 +The \*(L"prepararation\*(R" step creates a XMLdump and writes it into the
1.246 +\&\f(CW\*(C`${REGISTRY_PREP}\*(C'\fR file. The \*(L"transaction\*(R" step is a fake only. It assumes a
1.247 +successful response from the Registration server and saves it to
1.248 +\&\f(CW\*(C`${REGISTRY_TRAN}\*(C'\fR file. The \*(L"utilization\*(R" step processes this response and
1.249 +writes the final results to the \f(CW\*(C`${REGISTRY_UTIL}\*(C'\fR file.
1.250 +\&\fINote\fR: fake mode is meant as a way to register instances which cannot or must
1.251 +not post data directly to the Registration server.
1.252 +.Sp
1.253 +In \fBwipe\fR mode, the registration is wiped out locally. The status is reset
1.254 +and \s-1URL\s0 rewriting is disabled.
1.255 +\&\fINote\fR: the registration server is not contacted, the instace must be removed
1.256 +manually using the web interface.
1.257 +\&\fINote\fR: wiping registration is highly recommended as a precursor action of
1.258 +cloning activities.
1.259 +.ie n .IP "\fB\-a\fR, \fB\-\-args\fR ""arg [arg ...]""" 4
1.260 +.el .IP "\fB\-a\fR, \fB\-\-args\fR ``arg [arg ...]''" 4
1.261 +.IX Item "-a, --args arg [arg ...]"
1.262 +Overrides \f(CW\*(C`${REGISTRY_ARGS}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.263 +Complements the mode and is specific to it.
1.264 +Defaults to \*(L"http://registry.openpkg.org/register\*(R" which is the official registry of the OpenPKG Project.
1.265 +This default is useful for \*(L"post\*(R" mode.
1.266 +.IP "\fB\-u\fR, \fB\-\-user\fR \fIuser|token\fR" 4
1.267 +.IX Item "-u, --user user|token"
1.268 +Overrides \f(CW\*(C`${REGISTRY_USER}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.269 +Indicates the registry user which will find this registration in his arrival queue.
1.270 +The user can also specified as a token which is enabled for use as \*(L"user\*(R".
1.271 +If the token is also enabled for \*(L"assoc\*(R" the registered instance is immediately associated
1.272 +to the user with no need for the user to visit the web interface.
1.273 +This information in submitted via the \*(L"registry_user\*(R" attribute of the \s-1XML\s0 request.
1.274 +Retrieves default online from http://openpkg.org/go/autoregister and is a manadatory setting.
1.275 +.IP "\fB\-l\fR, \fB\-\-link\fR \fItoken\fR" 4
1.276 +.IX Item "-l, --link token"
1.277 +Overrides \f(CW\*(C`${REGISTRY_LINK}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.278 +Indicates the registry user which will find this registration linked to his token.
1.279 +The link must be specified as a token which is enabled for use as \*(L"link\*(R".
1.280 +If a user token is used and the link token is also enabled for \*(L"assoc\*(R" then the registered instance
1.281 +is immediately associated to the user with no need for the user to visit the web interface.
1.282 +This information in submitted via the \*(L"registry_link\*(R" attribute of the \s-1XML\s0 request.
1.283 +Has no default and is an optional setting.
1.284 +Be aware that linked users see the same information about an instance as the associated user
1.285 +can find on his \*(L"association\*(R" page but they cannot alter or delete information.
1.286 +.IP "\fB\-d\fR, \fB\-\-desc\fR \fIdescription\fR" 4
1.287 +.IX Item "-d, --desc description"
1.288 +Overrides \f(CW\*(C`${REGISTRY_DESC}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.289 +Indicates a human readable description of the instance.
1.290 +This information in submitted via the \*(L"registry_desc\*(R" attribute of the \s-1XML\s0 request.
1.291 +It appears in the \*(L"description\*(R" column on the \*(L"association\*(R" page of the web form and can be edited on the server side.
1.292 +Defaults to \*(L"openpkg://${\s-1FQDN\s0}${\s-1PREFIX\s0}\*(R"
1.293 +.SH "ADVANCED OPTIONS"
1.294 +.IX Header "ADVANCED OPTIONS"
1.295 +Advanced options can be enganged to tailor and fully automate a registration
1.296 +(not association).
1.297 +.IP "\fB\-\-plat\fR" 4
1.298 +.IX Item "--plat"
1.299 +Overrides \f(CW\*(C`${REGISTRY_PLAT}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.300 +Indicates the platform. Concatenated information from \s-1CPU\s0 architecture (arch) and Operating System (os).
1.301 +This information in submitted via the \*(L"registry_plat\*(R" attribute of the \s-1XML\s0 request.
1.302 +Defaults to \*(L"%{l_platform \-p}\*(R", e.g. \*(L"ix86\-freebsd6.1\*(R"
1.303 +.IP "\fB\-\-orel\fR" 4
1.304 +.IX Item "--orel"
1.305 +Overrides \f(CW\*(C`${REGISTRY_VERS}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.306 +Indicates the OpenPKG release.
1.307 +This information in submitted via the \*(L"registry_orel\*(R" attribute of the \s-1XML\s0 request.
1.308 +Defaults to \*(L"%{l_openpkg_release}\*(R", e.g. \*(L"OpenPKG-CURRENT\*(R", \*(L"OpenPKG\-2\-STABLE\*(R", \*(L"OpenPKG\-2.5\*(R",
1.309 +.IP "\fB\-\-uuid\fR" 4
1.310 +.IX Item "--uuid"
1.311 +Overrides \f(CW\*(C`${REGISTRY_UUID}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.312 +Indicates the \s-1UUID\s0 file of the instance.
1.313 +This information in submitted via the \*(L"uuid_registry\*(R", \*(L"uuid_instance\*(R" and \*(L"uuid_platform\*(R" attributes of the \s-1XML\s0 request.
1.314 +Defaults to \fI${\s-1PREFIX\s0}/etc/openpkg/uuid\fR
1.315 +.IP "\fB\-\-conf\fR" 4
1.316 +.IX Item "--conf"
1.317 +Overrides \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR variable from previous \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file. Processing
1.318 +of the current configuration file is aborted immediately with all variables
1.319 +read so far kept. THe new configuration file is read in immediately and
1.320 +processing continues there. This works similar to an include but is more
1.321 +primitive as it does not allow nesting, only chaining.
1.322 +Defaults to \fI${\s-1PREFIX\s0}/etc/openpkg/register.conf\fR
1.323 +.IP "\fB\-\-prep\fR" 4
1.324 +.IX Item "--prep"
1.325 +Overrides \f(CW\*(C`${REGISTRY_PREP}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.326 +File to save a copy of the output from the \*(L"preparation\*(R" step.
1.327 +Defaults to \fI${\s-1PREFIX\s0}/etc/openpkg/register.prep\fR
1.328 +.IP "\fB\-\-tran\fR" 4
1.329 +.IX Item "--tran"
1.330 +Overrides \f(CW\*(C`${REGISTRY_TRAN}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.331 +File to save a copy of the output from the \*(L"transaction\*(R" step.
1.332 +Defaults to \fI${\s-1PREFIX\s0}/etc/openpkg/register.tran\fR
1.333 +.IP "\fB\-\-util\fR" 4
1.334 +.IX Item "--util"
1.335 +Overrides \f(CW\*(C`${REGISTRY_UTIL}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.336 +File to save a copy of the output from the \*(L"utilization\*(R" step.
1.337 +Defaults to \fI${\s-1PREFIX\s0}/etc/openpkg/register.util\fR
1.338 +.IP "\fB\-\-data\fR" 4
1.339 +.IX Item "--data"
1.340 +Overrides \f(CW\*(C`${REGISTRY_DATA}\*(C'\fR variable in \f(CW\*(C`${REGISTRY_CONF}\*(C'\fR file.
1.341 +Comma separated list of tags to prepare. Available tags are \*(L"request\*(R",
1.342 +\&\*(L"package\*(R" and \*(L"provides\*(R". The \*(L"request\*(R" refers to the whole thing and
1.343 +is mandatory. The \*(L"package\*(R" includes name-version-release information
1.344 +for all installed packages and \*(L"provides\*(R" adds more details required to
1.345 +capture package options. For details see \s-1OPENPKG_PREP\s0 below.
1.346 +Defaults to \*(L"request,package,provides\*(R"
1.347 +.SH "FILES"
1.348 +.IX Header "FILES"
1.349 +The following files are used by \fBopenpkg register\fR:
1.350 +.IP "OPENPKG_UUID=\fI${\s-1PREFIX\s0}/etc/openpkg/uuid\fR" 4
1.351 +.IX Item "OPENPKG_UUID=${PREFIX}/etc/openpkg/uuid"
1.352 +.Vb 3
1.353 +\& UUID_REGISTRY="..."
1.354 +\& UUID_INSTANCE="..."
1.355 +\& UUID_PLATFORM="..."
1.356 +.Ve
1.357 +.IP "OPENPKG_CONF=\fI${\s-1PREFIX\s0}/etc/openpkg/register.conf\fR" 4
1.358 +.IX Item "OPENPKG_CONF=${PREFIX}/etc/openpkg/register.conf"
1.359 +Format suitable for shell evaluation. Interactive mode appends remarked date
1.360 +and current settings for reuse as new defaults for future runs. Can be preset
1.361 +to customize or automate registration.
1.362 +.IP "OPENPKG_PREP=\fI${\s-1PREFIX\s0}/etc/openpkg/register.prep\fR" 4
1.363 +.IX Item "OPENPKG_PREP=${PREFIX}/etc/openpkg/register.prep"
1.364 +.Vb 10
1.365 +\& <?xml version="1.0" encoding="iso\-8859\-1" standalone="no"?>
1.366 +\& <!DOCTYPE registry
1.367 +\& PUBLIC "\-//OpenPKG//DTD OpenPKG Registry 0.0.1//EN"
1.368 +\& "http://registry.openpkg.org/registry.dtd" []>
1.369 +\& <registry>
1.370 +\& <request id="..."
1.371 +\& registry_user="me@example.com"
1.372 +\& registry_desc="openpkg://rm0.openpkg.net/openpkg\-dev"
1.373 +\& registry_plat="ix86\-freebsd6.1"
1.374 +\& registry_orel="OpenPKG\-CURRENT"
1.375 +\& uuid_registry="..."
1.376 +\& uuid_instance="..."
1.377 +\& uuid_platform="..."
1.378 +\& />
1.379 +\& <package id="..." name="ssmtp" version="2.61" release="20050608">
1.380 +\& <provides name="ssmtp::with_ssl" flag="=" version="no"/>
1.381 +\& <provides name="MTA" flag="" version=""/>
1.382 +\& <provides name="ssmtp" flag="=" version="2.61\-20050608"/>
1.383 +\& </package>
1.384 +\& </registry>
1.385 +.Ve
1.386 +.Sp
1.387 +The \s-1XML\s0 request starts with <?xml version ...> and <!DOCTYPE registry ...>
1.388 +headers followed by a <registry> container. The request is inside a <request>
1.389 +tag. Successful submission into the XMLdump form requires the headers and
1.390 +exactly one container. It is possible to merge multiple requests into a single
1.391 +container manually or otherwise and submit them all at once.
1.392 +.IP "OPENPKG_TRAN=\fI${\s-1PREFIX\s0}/etc/openpkg/register.tran\fR" 4
1.393 +.IX Item "OPENPKG_TRAN=${PREFIX}/etc/openpkg/register.tran"
1.394 +.Vb 7
1.395 +\& <?xml version="1.0" encoding="iso\-8859\-1" standalone="no"?>
1.396 +\& <!DOCTYPE registry
1.397 +\& PUBLIC "\-//OpenPKG//DTD OpenPKG Registry 0.0.1//EN"
1.398 +\& "http://registry.openpkg.org/registry.dtd" []>
1.399 +\& <registry>
1.400 +\& <response id="..." done="yes">openpkg://rm0.openpkg.net/openpkg\-dev</response>
1.401 +\& </registry>
1.402 +.Ve
1.403 +.Sp
1.404 +The \s-1XML\s0 response starts with <?xml version ...> and <!DOCTYPE registry ...>
1.405 +headers followed by a <registry> container. The response is inside a <request>
1.406 +tag. The data carried in the tag comes from the \*(L"description\*(R" column on the
1.407 +\&\*(L"association\*(R" page of the web form and can be edited on the server side.
1.408 +.IP "OPENPKG_UTIL=\fI${\s-1PREFIX\s0}/etc/openpkg/register.util\fR" 4
1.409 +.IX Item "OPENPKG_UTIL=${PREFIX}/etc/openpkg/register.util"
1.410 +.Vb 3
1.411 +\& REGISTRY_DBID="..."
1.412 +\& REGISTRY_DONE="yes"
1.413 +\& REGISTRY_RESP="openpkg://foo.example.com/my/openpkg/prefix"
1.414 +.Ve
1.415 +.SH "EXAMPLES"
1.416 +.IX Header "EXAMPLES"
1.417 +.Vb 10
1.418 +\& # su \- openpkg\-mop
1.419 +\& $ openpkg register \-\-printstatus
1.420 +\& REGISTRY_DBID="..."
1.421 +\& REGISTRY_DONE="yes"
1.422 +\& REGISTRY_RESP="openpkg://foo.example.com/my/openpkg/prefix"
1.423 +\& $ openpkg register \-\-printstatus >/dev/null && echo "Yup"
1.424 +\& Yup
1.425 +\& $ eval \`openpkg register \-\-printstatus\`; echo DONE=$REGISTRY_DONE
1.426 +\& DONE=yes
1.427 +\& $ openpkg register \-\-mode=wipe
1.428 +\& $ openpkg register \-\-printstatus || echo "Nope"
1.429 +\& Nope
1.430 +\& $ openpkg register \-\-user=thl@openpkg.net \-\-mode=post
1.431 +\& REGISTRY_DBID="...."
1.432 +\& REGISTRY_DONE="yes"
1.433 +\& REGISTRY_RESP="openpkg://foo.example.com/my/openpkg/prefix"
1.434 +\& $ openpkg register \-\-printstatus >/dev/null && echo "Yup"
1.435 +\& Yup
1.436 +\& $ openpkg register \-\-rewriteurls http://download.openpkg.org/foo/bar
1.437 +\& ftp://...:...@download.openpkg.org/foo/bar
1.438 +.Ve
1.439 +.SH "SEE ALSO"
1.440 +.IX Header "SEE ALSO"
1.441 +\&\fIbash\fR\|(1), \f(CW\*(C`openpkg man uuid\*(C'\fR, \f(CW\*(C`http://registry.openpkg.org/\*(C'\fR
1.442 +.SH "AUTHOR"
1.443 +.IX Header "AUTHOR"
1.444 +Thomas Lotterer <thl@openpkg.org>
