File yup.1.pod of Package yup

#
#	MANPAGE
#

=head1 NAME

YUP - "Yum Update Proxy" for SLE 10 Maintenance

=head1 SYNOPSIS

Yup does not take command line parameters; for configuration see B<OPTIONS> below.

=head1 DESCRIPTION

Yup is a tool to mirror updates for Novell maintenance packages for SUSE Linux
Enterprise 10 products.

=head1 OPTIONS

=head2 Network Configuration

Yup uses the system's proxy settings as configured in F</etc/sysconfig/proxy>.  In addition, secrets for proxy-authentication should be stored in F</root/.curlrc>. This is done automatically, if the YaST proxy-module is used. There are only two relevant proxy-settings (besides authentication):

=over

=item PROXY_ENABLED

yes/no

=item HTTPS_PROXY

valid proxy-url

=back

=head2 Configuration File(s)

Yup needs a configuration file, currently: F</etc/sysconfig/yup>. On SUSE Linux systems, this file can be changed by also using YaST's sysconfig-editor (System/YUP).

Alternatively, it is possible to put several configuration files into the (hardcoded) directory F</etc/sysconfig/yup.d>; Yup loops over those files, the single file F</etc/sysconfig/yup> is ignored in this case.

=over

=item YUP_CURL

Path and name of curl binary, default: F</usr/bin/curl>. This might be useful on systems which need a non-standard curl-binary to make Yup work (e.g. SLES 9).

=item YUP_CURLPARAMS

Standard parameters for curl: --digest is vital for authentication, --verbose and --fail are necessary for correct error handling, default F<--verbose --digest --remote-time --fail>

=item YUP_DEST_DIR

Destination path (script will create sub-directories there), default: F</var/cache/yup>

=item YUP_ID

Machine ID: this value is in F</etc/zmd/deviceid> on the machine you registered with. This is the default ID and also used for the SDK.

=item YUP_PASS

Machine Secret: this value is in F</etc/zmd/secret> on the machine you registered with. This is the default Secret and also used for the SDK.

=item YUP_SERVER
 
The update server to use, default F<nu.novell.com>

=item YUP_ID_SLED

Machine ID: this value is in F</etc/zmd/deviceid> on the machine you registered SLED with. If not set, YUP_ID will be used.

=item YUP_PASS_SLED

Machine Secret: this value is in F</etc/zmd/secret> on the machine you registered SLED with. If not set, YUP_PASS will be used.

=item YUP_SERVER_SLED

The update server to use for SLED, default F<YUP_SERVER>

=item YUP_ID_SLES

Machine ID: this value is in F</etc/zmd/deviceid> on the machine you registered SLES with. If not set, YUP_ID will be used.

=item YUP_PASS_SLES

Machine Secret: this value is in F</etc/zmd/secret> on the machine you registered SLES with. If not set, YUP_PASS will be used.

=item YUP_SERVER_SLES
 
The update server to use for SLES, default F<YUP_SERVER>

=item YUP_ARCH

Architecture to mirror, default: F<i586>
SPACE separated list.

=item YUP_PRODUCTS

Products to mirror (SLES10 and/or SLED10), default: F<SLES10>. For DebugInfo and SDK see: YUP_DEBUGINFO, YUP_SDK.
SPACE separated list.

=item YUP_SUBVERSIONS

Which product releases of a product should be mirrored? (GA, SP1, SP2), default: F<GA>. SPACE separated list.

=item YUP_SP_SUBCHANS

Subchannels to include while mirroring an SP; F<-Online> the patches to go from SP(N-1) to SP(N); F<-Updates> the patches for SP(N); default:     "-Updates -Online"

=item YUP_DEBUGINFO

Include DebugInfo in mirror? Default: F<no> Enable with F<yes>.

=item YUP_SDK

Include SDK in mirror? Default: F<no> Enable with F<yes>.

=item YUP_DRYRUN

Only show channels/URLs to access, do not download.
Default: F<no> Enable with F<yes>.

=back

Additionally here are some parameters for downloading the SRC-RPMs.
At the moment those packages are located on a different server (F<you.novell.com>),
but in full sync with F<nu.novell.com>.

=over

=item YUP_SRCRPM

Include .src.rpms in mirror? Default: F<no> Enable with F<you>, to download from F<you.novell.com>, later in 2007 also downloads from F<nu.novell.com> might be possible; enable this with F<yes>.

=item YOU_NCC_ACCOUNT

Your NCC account (necessary F<for you.novell.com>)

=item YOU_NCC_PASSWORD

Your NCC password (necessary F<for you.novell.com>)

=item YOU_SERVER

F<you.novell.com>

=back

We also addded a way to save some space by hardlinking
identical files in your mirror area.

=over

=item YUP_HARDLINK

Safe storage space by finding duplicate rpms files and hardlinking those files?  Default: F<no>, enable with F<yes>.

=item YUP_PATSIZE

Only hardlink files larges than YUP_PATSIZE blocks (find parameter). YUP_HARDLINK must be "yes" for YUP_PATSIZE having any effect. Default: F<+20000>.

=item YUP_MTIME

Only hardlink files older/younger than YUP_MTIME days (find parameter). YUP_HARDLINK must be "yes" for YUP_MTIME having any effect. Default: F<-8> (last week).

=back

=head2 Mirror credentials for SLE 10 SP 1

For SUSE Linux Enterprise 10 SP 1 we enhanced the capabilities
of the Novell Customer Center. For that reason please get
your YUP mirror credentials there:

=over

=item Step 1) go into Novell Customer Center http://www.novell.com/center

=item Step 2) click on "Products and Subscriptions --> List of Products and Subscriptions"

=item Step 3) double click on any specific subscription

=item Step 4) click on the mirror credentials link at the bottom of the page

=item Step 5) if necessary, like first time accessing the page, click on the generate button

=back

The credentials and mirror sites will be listed. 
These values will be the same across all users and subscriptions for a specific company.

=head1 ERROR HANDLING

Yup will exit with an error status if meta data for a catalog (for example, the
list of patches) cannot be downloaded. Yup will continue working when a regular
data file in a catalog, like an RPM package, cannot be downloaded, but will
exit with an error code later on.

=head1 BUGS

Yup does not work properly on a standard SLES 9 at the moment; a special curl binary is necessary (curl >= 7.12.0 ) to make Yup work here. Use the YUP_CURL variable to work around this limitation.

=head1 FILES

=over

=item /etc/sysconfig/yup

Yup's primary configuration file

=item /etc/sysconfig/proxy

Proxy settings for HTTP and HTTPS

=item /root/.curlrc

Configuration file for curl.

=back

=head1 SEE ALSO

L<yup2zlm(1)>, L<curl(1)>

The Novell knowledge base, L<http://support.novell.com>.

=head1 NOTES

Please make sure, that the number of systems to serve with the mirrored
packages is in compliance with the number of subscriptions you are allowed to
exercise according to your contract with Novell.

Yup is delivered without any maintenance, support and warranty.

=head1 AUTHORS and CONTRIBUTORS

Marcus Meissner, Eberhard Moenkeberg, Ray Dassen, Jo de Baer (yup2zlm),
Thomas Maynard, Matthias Eckermann

=head1 LICENSE

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 675 Mass
Ave, Cambridge, MA 02139, USA.

=cut