Project

General

Profile

TOC PREV NEXT
Fermilab CD logo Complete Guide and Reference Manual for UPS and UPD

Chapter Contents

About this Manual
   1. Document Structure, Purpose and Intended Audiences
   2. Conventions

  About this Manual

  This chapter provides an introduction to the Complete Guide and Reference Manual for UPS and UPD .

  1. Document Structure, Purpose and Intended Audiences

  To best accommodate different types of users, the manual is divided into five user guides (Parts I-V):

  and three reference manuals (Parts VI-VIII)

  The user guides explain and illustrate the UPS/UPD tasks associated with each user group. The reference guides provide detailed information on commands, concepts, file structure/contents, and so on. Here is a guide to which parts of the manual you are likely to need, according to your job functions. Notice that we recommend Parts I and VI for all users:

 

Parts Parts User Functions User Functions
A: For All Users A: For All Users
Part I Overview and End User's Guide Part I Overview and End User's Guide End Users: End Users: List product information in a UPS database on a user system; List product information in a UPS database on a user system; Access installed software products Access installed software products Access FermiTools software products Access FermiTools software products ( Other user groups' functions described later in table ) ( Other user groups' functions described later in table )
Part VI UPS and UPD Command Reference Part VI UPS and UPD Command Reference
B: For Product Installers, UPS Database Administrators, System Administrators of User Machines, Distribution Node Maintainers B: For Product Installers, UPS Database Administrators, System Administrators of User Machines, Distribution Node Maintainers
Part II Product Installer's Guide Part II Product Installer's Guide Product Installers: Product Installers: Install software products from a UPS product distribution node into a UPS database on a user system; Install software products from a UPS product distribution node into a UPS database on a user system; Install products into the AFS-space UPS database Install products into the AFS-space UPS database
Part III System Administrator's Guide Part III System Administrator's Guide and and Part VII Administrator's Reference Part VII Administrator's Reference System Administrators, UPS Database Administrators: System Administrators, UPS Database Administrators: Maintain UPS products in a UPS database; Maintain UPS products in a UPS database; Install UPS / UPD on a user system; Install UPS / UPD on a user system; Configure UPS on a user system; Configure UPS on a user system; Configure UPD on a user system; Configure UPD on a user system; Configure an installed product to start/stop automatically at boottime/shutdown Configure an installed product to start/stop automatically at boottime/shutdown
Part V Distribution Node Maintainer's Guide Part V Distribution Node Maintainer's Guide Distribution Node Maintainers: Distribution Node Maintainers: Install UPS / UPD on a distribution system; Install UPS / UPD on a distribution system; Configure UPS and UPD on a distribution system; Configure UPS and UPD on a distribution system; Configure Web and anonymous FTP servers on a distribution system Configure Web and anonymous FTP servers on a distribution system Maintain UPS database on a distribution system Maintain UPS database on a distribution system
C: Product Developers C: Product Developers
Part IV Product Developer's Guide Part IV Product Developer's Guide Product Developers and Maintainers: Product Developers and Maintainers: Develop and maintain software products that are intended to be distributed in accordance with UPS standards; Develop and maintain software products that are intended to be distributed in accordance with UPS standards; Adapt pre-existing or third-party software to conform to UPS standards; Adapt pre-existing or third-party software to conform to UPS standards; Distribute products Distribute products
Part VIII Developer's Reference Part VIII Developer's Reference

  2. Conventions

  The following notational conventions are used in this document:

  bold

  Used for product names (e.g., UPS ).

  italic

  Used to emphasize a word or concept in the text. Also used to indicate logon ids and node names.

  typewriter

  Used for filenames, pathnames, contents of files, output of commands. Also used to indicate commands and prompts.

  [...]

  In commands, square brackets indicate optional command arguments and options.

  |

  When shown in a command example (e.g., x|y|z ), separates a series of options from which one may or must be chosen (depends if enclosed in square brackets). In UNIX commands, used to pipe output of preceding command to the following one.

  ' ... '

  Single vertical quotes indicate apostrophes in commands.

  " ... "

  Double vertical quotes indicate double quotes in commands

  ...

  In a command, means that a repetition of the preceding parameter or argument is allowed.

  {font-weight: bold;font-family: monospace}%

  Prompt for C shell family commands ( {font-weight: bold;font-family: monospace}% is also used throughout this document when a command works for both shell families).

  $

  Prompt for Bourne shell family commands; also standard UNIX prefix for environment variables (e.g., $VAR means "the value to which VAR is set").

  \

  UNIX standard quoting character; used in commands throughout the manual to indicate that the command continues to the next line

  <...>

  In commands, variables, pathnames and filenames, angle brackets indicate strings for which reader must make a context-appropriate substitution. For example, $<PRODUCT>_DIR becomes $EMACS_DIR for the product emacs .

  { }

  In local read-only variables, e.g., ${UPS_PROD_DIR}, string should be used as shown with the {}.

  All command examples are followed by an implicit carriage return key.

  Some of the files discussed in this document are shell family-specific, and thus come in pairs. Their filenames carry the extensions .sh and .csh . We often refer to a pair of these files as filename.[c]sh .

  The following symbols are used throughout this document to draw your attention to specific items in the text:

  A "bomb"; this refers to something important you need to know in order to avoid a pitfall.

  This symbol is intended to draw your attention to a useful hint.

 

 

TOC PREV NEXT

This page last revised May 2014

TOC PREV NEXT
Fermilab CD logo Complete Guide and Reference Manual for UPS and UPD

Chapter Contents

About this Manual
   1. Document Structure, Purpose and Intended Audiences
   2. Conventions

  About this Manual

  This chapter provides an introduction to the Complete Guide and Reference Manual for UPS and UPD .

  1. Document Structure, Purpose and Intended Audiences

  To best accommodate different types of users, the manual is divided into five user guides (Parts I-V):

  and three reference manuals (Parts VI-VIII)

  The user guides explain and illustrate the UPS/UPD tasks associated with each user group. The reference guides provide detailed information on commands, concepts, file structure/contents, and so on. Here is a guide to which parts of the manual you are likely to need, according to your job functions. Notice that we recommend Parts I and VI for all users:

 

Parts Parts User Functions User Functions
A: For All Users A: For All Users
Part I Overview and End User's Guide Part I Overview and End User's Guide End Users: End Users: List product information in a UPS database on a user system; List product information in a UPS database on a user system; Access installed software products Access installed software products Access FermiTools software products Access FermiTools software products ( Other user groups' functions described later in table ) ( Other user groups' functions described later in table )
Part VI UPS and UPD Command Reference Part VI UPS and UPD Command Reference
B: For Product Installers, UPS Database Administrators, System Administrators of User Machines, Distribution Node Maintainers B: For Product Installers, UPS Database Administrators, System Administrators of User Machines, Distribution Node Maintainers
Part II Product Installer's Guide Part II Product Installer's Guide Product Installers: Product Installers: Install software products from a UPS product distribution node into a UPS database on a user system; Install software products from a UPS product distribution node into a UPS database on a user system; Install products into the AFS-space UPS database Install products into the AFS-space UPS database
Part III System Administrator's Guide Part III System Administrator's Guide and and Part VII Administrator's Reference Part VII Administrator's Reference System Administrators, UPS Database Administrators: System Administrators, UPS Database Administrators: Maintain UPS products in a UPS database; Maintain UPS products in a UPS database; Install UPS / UPD on a user system; Install UPS / UPD on a user system; Configure UPS on a user system; Configure UPS on a user system; Configure UPD on a user system; Configure UPD on a user system; Configure an installed product to start/stop automatically at boottime/shutdown Configure an installed product to start/stop automatically at boottime/shutdown
Part V Distribution Node Maintainer's Guide Part V Distribution Node Maintainer's Guide Distribution Node Maintainers: Distribution Node Maintainers: Install UPS / UPD on a distribution system; Install UPS / UPD on a distribution system; Configure UPS and UPD on a distribution system; Configure UPS and UPD on a distribution system; Configure Web and anonymous FTP servers on a distribution system Configure Web and anonymous FTP servers on a distribution system Maintain UPS database on a distribution system Maintain UPS database on a distribution system
C: Product Developers C: Product Developers
Part IV Product Developer's Guide Part IV Product Developer's Guide Product Developers and Maintainers: Product Developers and Maintainers: Develop and maintain software products that are intended to be distributed in accordance with UPS standards; Develop and maintain software products that are intended to be distributed in accordance with UPS standards; Adapt pre-existing or third-party software to conform to UPS standards; Adapt pre-existing or third-party software to conform to UPS standards; Distribute products Distribute products
Part VIII Developer's Reference Part VIII Developer's Reference

  2. Conventions

  The following notational conventions are used in this document:

  bold

  Used for product names (e.g., UPS ).

  italic

  Used to emphasize a word or concept in the text. Also used to indicate logon ids and node names.

  typewriter

  Used for filenames, pathnames, contents of files, output of commands. Also used to indicate commands and prompts.

  [...]

  In commands, square brackets indicate optional command arguments and options.

  |

  When shown in a command example (e.g., x|y|z ), separates a series of options from which one may or must be chosen (depends if enclosed in square brackets). In UNIX commands, used to pipe output of preceding command to the following one.

  ' ... '

  Single vertical quotes indicate apostrophes in commands.

  " ... "

  Double vertical quotes indicate double quotes in commands

  ...

  In a command, means that a repetition of the preceding parameter or argument is allowed.

  {font-weight: bold;font-family: monospace}%

  Prompt for C shell family commands ( {font-weight: bold;font-family: monospace}% is also used throughout this document when a command works for both shell families).

  $

  Prompt for Bourne shell family commands; also standard UNIX prefix for environment variables (e.g., $VAR means "the value to which VAR is set").

  \

  UNIX standard quoting character; used in commands throughout the manual to indicate that the command continues to the next line

  <...>

  In commands, variables, pathnames and filenames, angle brackets indicate strings for which reader must make a context-appropriate substitution. For example, $<PRODUCT>_DIR becomes $EMACS_DIR for the product emacs .

  { }

  In local read-only variables, e.g., ${UPS_PROD_DIR}, string should be used as shown with the {}.

  All command examples are followed by an implicit carriage return key.

  Some of the files discussed in this document are shell family-specific, and thus come in pairs. Their filenames carry the extensions .sh and .csh . We often refer to a pair of these files as filename.[c]sh .

  The following symbols are used throughout this document to draw your attention to specific items in the text:

  A "bomb"; this refers to something important you need to know in order to avoid a pitfall.

  This symbol is intended to draw your attention to a useful hint.

 

 

TOC PREV NEXT

This page last revised May 2014