From fba9f0903819cd39636e074e71214cff28194f41 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Franti=C5=A1ek=20Dvo=C5=99=C3=A1k?= Date: Tue, 20 Nov 2012 14:17:00 +0000 Subject: [PATCH] glite-lb-setup man page edited --- org.glite.lb.server/doc/glite-lb-setup.8 | 61 ++++++++++++++++---------------- 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/org.glite.lb.server/doc/glite-lb-setup.8 b/org.glite.lb.server/doc/glite-lb-setup.8 index 2486bbe..8b727fc 100644 --- a/org.glite.lb.server/doc/glite-lb-setup.8 +++ b/org.glite.lb.server/doc/glite-lb-setup.8 @@ -1,26 +1,26 @@ .TH GLITE-LB-SETUP 19 "November 2012" "EMI Project" "Logging&Bookkeeping" .SH NAME -glite-lb-setup - script for setup L&B +glite-lb-setup - script for setting up L&B services .SH SYNOPSIS \fBglite-lb-setup\fR [\fIOPTIONS\fR] [\fIACTION...\fR] .SH DESCRIPTION -Script \fBglite-lb-setup\fR setups L&B server based on environment and sourced files. Setup is divided into tasks: \fBACTIONS\fR. +The \fBglite-lb-setup\fR script sets up the L&B server based on environment and sourced files. The setup process is divided into individual \fBACTIONS\fR. .SH OPTIONS .TP \fB\-q\fR, \fP--quiet\fR -Print only the errors. +Print only errors. .TP \fB\-c\fR, \fP--check\fR -Check availability of the database (if setup has been already performed). If there are no other \fBACTIONS\fR listed, no default actions are performed and \fBglite-lb-setup\fR will exit immediately with 0 return code (if database exists) or 1 (in other cases). +Check database availability (check if setup has been already performed). In case there are no other \fBACTIONS\fR listed, no default actions are performed and \fBglite-lb-setup\fR will exit immediately with return code 0 (if database exists) or 1 (in other cases). .TP \fB\-l\fR, \fP--list\fR -List the \fBACTIONS\fR to be executed and exit. It can be used to see and/or select actions to be performed during setup. For example list the actions and omit setup of BDII: +List \fBACTIONS\fR to be executed and exit. This option can be used to view and/or select actions to be performed during setup. For example, the following pair of commands lists available actions and runs the setup omitting BDII: glite-lb-setup --list glite-lb-setup `glite-lb-setup --list | sed 's/bdii//'` @@ -34,35 +34,35 @@ Display help. .TP \fBall\fR (group) -All default actions. If no action is listed on command line, this action will be performed. +All default actions. If no action is listed in the command line, this one will be performed. .TP \fBnone\fR (group) -No actions. +No action. .TP \fByaim\fR (group) -Actions to be used when launching setup inside YAIM configurator. Some actions (like BDII or CRL) are already covered by YAIM, so they are not performed. +Actions to be run when launching setup from within the YAIM configurator. Some regular actions (like BDII or CRL) are already covered by YAIM, so they are not performed. .TP \fBlogger\fR (group) -Actions needed to setup only L&B logger. Only setup certificates, messaging and update actions will be performed. +Only actions needed to set up and L&B logger will be performed. This action consists in setting up certificates, messaging, and running the update action. .TP \fBdb\fR -Check MySQL, enable MySQL configuration for L&B, setup the database and creates indexes. Migrate from L&B 3.x if needed. Start up of the MySQL server is handled in \fBstartup\fR, if enabled. +Checks MySQL, enables MySQL configuration for L&B, sets up the database and creates indices. Migrates DB from L&B version 3.x if necessary. MySQL server startup is handled in \fBstartup\fR, if enabled. .TP \fBcerts\fR -Check and copy host certificates for L&B services. +Checks and copies host certificates for L&B services. .TP \fBmsg\fR -Configure EMI Messaging. It uses the \fBglite-lb-msg-config\fR utility. +Configures EMI Messaging using the \fBglite-lb-msg-config\fR utility. .TP \fBauthz\fR -Create \fI/etc/glite-lb/glite-lb-authz.conf\fR file based on all the configuration variables: type of L&B node ($GLITE_LB_TYPE), service DNs ($GLITE_LB_WMS_DN, $GLITE_LB_SUPER_USERS, $GLITE_LB_RTM_DN) and fine-tuning variables $GLITE_LB_AUTHZ_*. +Creates file \fI/etc/glite-lb/glite-lb-authz.conf\fR based on all of the following configuration variables: type of L&B node ($GLITE_LB_TYPE), service DNs ($GLITE_LB_WMS_DN, $GLITE_LB_SUPER_USERS, $GLITE_LB_RTM_DN) and fine-tuning variables $GLITE_LB_AUTHZ_*. .TP \fBharvester\fR @@ -70,56 +70,56 @@ If enabled, L&B harvester will use local L&B server. .TP \fBbdii\fR -Setup BDII service and gLite info provider wrappers for L&B. Start up of the BDII service is handled in \fBstartup\fR, if enabled. +Sets up the BDII service and gLite info provider wrappers for L&B. BDII service startup is handled in \fBstartup\fR, if enabled. -Requires installed \fIbdii\fR, \fIsudo\fR, and \fIglite-info-provider-service\fR packages. +Packages \fIbdii\fR, \fIsudo\fR, and \fIglite-info-provider-service\fR must be intalled for this action to take effect. .TP \fBemir\fR -Create service info file and setup emi-serp. +Creates service info file and sets up emi-serp. -Requires installed \fIemird\fR or \fIemir-serp\fR package. +Package \fIemird\fR or \fIemir-serp\fR must be intalled for this action to take effect. .TP \fBupgrade\fR -Checks various old obsolete files to remove. +Checks for various obsolete files to remove. .TP \fBcrl\fR -Setup fetch-crl to automatic fetching of CRLs. +Sets up fetch-crl to fetch CRLs automatically. .TP \fBstartup\fR -Setup automatic start up of all enabled daemons after boot. +Sets up automatic startup of all enabled daemons after boot. .TP -\fBkrb\fR (not default) -Setup Kerberos ticket and credential cache files for L&B. +\fBkrb\fR (not run by default) +Sets up Kerberos ticket and credential cache files for L&B. Requires L&B built with Kerberos support. .TP -\fBkrbgsi\fR (not default) -Setup Kerberos and enable GSI authentication. +\fBkrbgsi\fR (not run by default) +Sets up Kerberos and enables GSI authentication. Requires L&B built with Kerberos support and modified Globus and Kerberos libraries. Tested only with Heimdal implementation of Kerberos. .SH FILES \fI/etc/profile.d/gridenv.sh\fR -Environment variables for setup and start up scripts. This is for interoperability with YAIM configurator. +Environment variables for setup and startup scripts. Used for interoperability with the YAIM configurator. \fI/etc/sysconfig/glite-lb\fR -Environment variables for setup and start up scripts on RedHat-like distributions (RedHat, Scientific, Fedora, ...). +Environment variables for setup and startup scripts in RedHat-like distributions (RedHat, Scientific Linux, Fedora, ...). \fI/etc/default/glite-lb\fR -Environment variables for setup and start up scripts on Debian. +Environment variables for setup and startup scripts in Debian. .SH ENVIRONMENT -See L&B Admin Guide, chapter 2.3.2 "Standard Installation". +See L&B Admin Guide, chapter 2.3.2 "Standard Installation." .SH EXAMPLES - Setup L&B server with both proxy and server mode on Scientific Linux with access for given gLite WMS: +Set up an L&B server running in the combined proxy and server ("BOTH") mode in Scientific Linux, granting WMS-specific permissions to the given gLite WMS instance: cat >> /etc/sysconfig/glite-lb <