.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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 >0, 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 "UPCLIENT 8" .TH UPCLIENT 8 "2023-12-24" "OpenAFS" "AFS Command Reference" .\" 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" upclient \- Initializes the client portion of the Update Server .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBupclient\fR\ <\fIhostname\fR> [\fB\-crypt\fR] [\fB\-clear\fR] [\fB\-t\fR\ <\fIretry\ time\fR>] [\fB\-verbose\fR]* <\fIdir\fR>+ [\fB\-help\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The upclient command initializes the client portion of the Update Server. In the conventional configuration, its binary file is located in the \fI/usr/lib/openafs\fR directory on a file server machine. .PP The upclient command is not normally issued at the command shell prompt but rather placed into a file server machine's \fI/etc/openafs/BosConfig\fR file with the \fBbos create\fR command. If it is ever issued at the command shell prompt, the issuer must be logged onto a database server machine as the local superuser \f(CW\*(C`root\*(C'\fR. .PP The upclient process periodically checks that all files in each local directory named by the \fIdir\fR argument match the files in the corresponding directory on the source machine named by the \fIhostname\fR argument. If a file does not match, the \fBupclient\fR process requests the source copy from the \fBupserver\fR process running on the source machine. .PP By default, the \fBupclient\fR process requests that the \fBupserver\fR process encrypt the data before transferring it. Use the \fB\-clear\fR flag to request unencrypted transfer if appropriate. (The \fB\-crypt\fR flag explicitly sets the default.) .PP In the conventional configuration, separate instances of the \fBupclient\fR process request data from the \fI/usr/lib/openafs\fR and \fI/etc/openafs/server\fR directories, except on machines for which the system control machine is also the binary distribution machine for the machine's system type. The conventional names for the separate instances are \f(CW\*(C`upclientbin\*(C'\fR and \&\f(CW\*(C`upclientetc\*(C'\fR respectively. .PP The \fBupclient\fR and \fBupserver\fR processes always mutually authenticate, whether or not the data they pass is encrypted; they use the key with the highest key version number in the \fI/etc/openafs/server/KeyFile\fR file to construct a server ticket for mutual authentication. .PP This command does not use the syntax conventions of the \s-1AFS\s0 command suites. Provide the command name and all option names in full. .SH "CAUTIONS" .IX Header "CAUTIONS" Do not use the Update Server to distribute the contents of the \&\fI/etc/openafs/server\fR directory using the \fB\-clear\fR option. The contents of this directory are sensitive. .SH "OPTIONS" .IX Header "OPTIONS" .IP "<\fIhostname\fR>" 4 .IX Item "" Names either the cell's system control machine (if the requested directory is \fI/etc/openafs/server\fR), or the binary distribution machine for the local machine's \s-1CPU\s0 and operating system type (if the requested directory is \&\fI/usr/lib/openafs\fR). .IP "\fB\-crypt\fR" 4 .IX Item "-crypt" Requests the transfer of data from the upserver process in encrypted form. This is the default; this flag just sets the default explicitly. Do not use this flag with the \fB\-clear\fR flag. .IP "\fB\-clear\fR" 4 .IX Item "-clear" Requests transfer of data from the \fBupserver\fR process in unencrypted form. Provide this flag or the \fB\-crypt\fR flag, but not both. .IP "\fB\-t\fR <\fIretry time\fR>" 4 .IX Item "-t " Specifies how often to check for changes in each specified directory, as a number of seconds. If this argument is omitted, the default is \f(CW300\fR (5 minutes). This argument determines the maximum amount of time it takes for a change made on the source machine to propagate to this machine. .IP "\fB\-verbose\fR*" 4 .IX Item "-verbose*" Writes a trace of the upclient process's operations on the standard output stream, which usually corresponds to the machine console. Provide one, two, or three instances of the flag; each additional instance generates increasingly numerous and detailed messages. .IP "<\fIdir\fR>+" 4 .IX Item "+" Names each directory to check for modified files. The conventional choices are the following: .RS 4 .IP "\(bu" 4 \&\fI/usr/lib/openafs\fR, in which case the recommended name for the process (assigned with the \fB\-instance\fR argument to the \fBbos create\fR command) is \&\f(CW\*(C`upclientbin\*(C'\fR. The \fIhostname\fR is the binary distribution machine for the local machine's system type. You may wish to use the \fB\-clear\fR flag for the \fI/usr/lib/openafs\fR directory, since binaries are not particularly sensitive and encrypting them takes system resources. .IP "\(bu" 4 \&\fI/etc/openafs/server\fR, in which case the recommended name for the process (assigned with the \fB\-instance\fR argument to the \fBbos create\fR command) is \&\f(CW\*(C`upclientetc\*(C'\fR. The \fIhostname\fR is the cell's system control machine. Use the \fB\-crypt\fR flag for the \fI/etc/openafs/server\fR directory, since it contains the \fIKeyFile\fR file and other data vital to cell security. .RE .RS 4 .RE .IP "\fB\-help\fR" 4 .IX Item "-help" Prints the online help for this command. All other valid options are ignored. .SH "EXAMPLES" .IX Header "EXAMPLES" The following bos create command creates an \f(CW\*(C`upclientbin\*(C'\fR process on the machine \f(CW\*(C`fs4.example.com\*(C'\fR that refers to the machine \f(CW\*(C`fs1.example.com\*(C'\fR as the source for the \fI/usr/lib/openafs\fR directory (thus \f(CW\*(C`fs1.example.com\*(C'\fR is the binary distribution machine for machines of \f(CW\*(C`fs4.example.com\*(C'\fR's type). The files in the \fI/usr/lib/openafs\fR directory are distributed every 120 seconds. The command requests transfer in unencrypted form. .PP .Vb 3 \& % bos create \-server fs4.example.com \-instance upclientbin \-type simple \e \& \-cmd "/usr/lib/openafs/upclient fs1.example.com \-clear \e \& \-t 120 /usr/lib/openafs" .Ve .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" The issuer must be logged in as the superuser \f(CW\*(C`root\*(C'\fR on a file server machine to issue the command at a command shell prompt. It is conventional instead to create and start the process by issuing the \fBbos create\fR command. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBBosConfig\fR\|(5), \&\fBbos_create\fR\|(8), \&\fBupserver\fR\|(8) .SH "COPYRIGHT" .IX Header "COPYRIGHT" \&\s-1IBM\s0 Corporation 2000. All Rights Reserved. .PP This documentation is covered by the \s-1IBM\s0 Public License Version 1.0. It was converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.