diff --git a/node-util/man8/oo-admin-cartridge.8 b/node-util/man8/oo-admin-cartridge.8 index b4dc0765dd3..4a89523e5de 100644 --- a/node-util/man8/oo-admin-cartridge.8 +++ b/node-util/man8/oo-admin-cartridge.8 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH oo-admin-cartridge 8 "21 January 2014" "" "" +.TH oo-admin-cartridge 8 "17 July 2014" "" "" .SH NAME \fBoo-admin-cartridge \fB @@ -7,8 +7,8 @@ .nf .fam C \fBoo-admin-cartridge\fP \fB--action\fP \fIinstall\fP [\fB--recursive\fP] [\fB--mco\fP] [\fB--source\fP \fIdirectory\fP] -\fBoo-admin-cartridge\fP \fB--action\fP \fIerase\fP [\fB--mco\fP] \fB--name\fP \fINAME\fP \fB--version\fP \fIVERSION\fP \fB--cartridge_version\fP \fIVERSION\fP -\fBoo-admin-cartridge\fP \fB--action\fP \fIlist\fP [\fB--mco\fP] +\fBoo-admin-cartridge\fP \fB--action\fP \fIerase\fP [\fB--mco\fP] \fB--cartridge_vendor\fP \fIVENDOR\fP \fB--name\fP \fINAME\fP \fB--version\fP \fIVERSION\fP \fB--cartridge_version\fP \fIVERSION\fP [\fB--force\fP] +\fBoo-admin-cartridge\fP \fB--action\fP \fIlist\fP [\fB--mco\fP] .fam T .fi @@ -22,17 +22,12 @@ simple RPM's are not viable. This command is used for repair and development work. Restarting the mcollectived openshift agent will cause all the cartridge in /usr/libexec/openshift/cartridges to be installed in the cartridge repository. .SH OPTIONS -.TP -.B \fB-h\fP|\fB--help\fP Display a simple help menu. -.TP -.B +.PP \fB-d\fP|\fB--debug\fP Provide additional output. .SH COMMANDS -.TP -.B \fB--action\fP ACTION \fIinstall\fP copies the cartridge source found at the \fIdirectory\fP provided by \fB--source\fP into the cartridge repository .RS @@ -46,37 +41,31 @@ to determine the version of the cartridge is not being used in any gear. \fIlist\fP \fIlist\fP the cartridge versions installed in the cartridge repository .RE -.TP -.B +.PP \fB--recursive\fP The source \fIdirectory\fP provided contains cartridge source directories, rather than pointing to one cartridge -.TP -.B +.PP \fB--mco\fP Use the mcollective mco agent to update the cartridge repository. -.TP -.B -\fB--name\fP \fINAME\fP \fB--version\fP \fIVERSION\fP \fB--cartridge_version\fP \fIVERSION\fP -When erasing a cartridge from the cartridge repository you must provide the exact version to remove. +.PP +\fB--cartridge_vendor\fP \fIVENDOR\fP \fB--name\fP \fINAME\fP \fB--version\fP \fIVERSION\fP \fB--cartridge_version\fP \fIVERSION\fP +.br +When erasing a cartridge from the cartridge repository you must provide the exact version to remove. 'redhat' is the +default \fIVENDOR\fP. +.PP +\fB--force\fP +Override verifications before erasing cartridge from repository .SH CONFIGURATION -.TP -.B /usr/libexec/openshift/cartridges default source \fIdirectory\fP -.TP -.B /var/lib/openshift/.cartridge_repository \fIdirectory\fP for storing cartridge repository .SH EXAMPLE -.TP -.B # \fBoo-admin-cartridge\fP \fB--action\fP \fIinstall\fP \fB--recursive\fP \fB--source\fP /usr/libexec/openshift/cartridges Install all current cartridges into cartridge repository -.TP -.B # \fBoo-admin-cartridge\fP \fB--action\fP \fIlist\fP List all versions of all cartridges \fIinstall\fP in cartridge repository .SH SEE ALSO .SH AUTHOR -Jhon Honce - man page written for OpenShift Origin +Jhon Honce - man page written for OpenShift Origin diff --git a/node-util/man8/oo-admin-cartridge.txt2man b/node-util/man8/oo-admin-cartridge.txt2man index d205eda3408..886cb5511bc 100644 --- a/node-util/man8/oo-admin-cartridge.txt2man +++ b/node-util/man8/oo-admin-cartridge.txt2man @@ -1,10 +1,10 @@ NAME - oo-admin-cartridge - + oo-admin-cartridge + SYNOPSIS oo-admin-cartridge --action install [--recursive] [--mco] [--source directory] - oo-admin-cartridge --action erase [--mco] --name NAME --version VERSION --cartridge_version VERSION - oo-admin-cartridge --action list [--mco] + oo-admin-cartridge --action erase [--mco] --cartridge_vendor VENDOR --name NAME --version VERSION --cartridge_version VERSION [--force] + oo-admin-cartridge --action list [--mco] DESCRIPTION oo-admin-cartridge provides OpenShift Operators the ability to update and maintain a Cartridge Repository @@ -15,41 +15,45 @@ DESCRIPTION all the cartridge in /usr/libexec/openshift/cartridges to be installed in the cartridge repository. OPTIONS - -h|--help + -h|--help Display a simple help menu. - -d|--debug + -d|--debug Provide additional output. COMMANDS - --action ACTION + --action ACTION install copies the cartridge source found at the directory provided by --source into the cartridge repository erase removes the named version of the cartridge from the cartridge repository. It is up to the OpenShift Operator to determine the version of the cartridge is not being used in any gear. list list the cartridge versions installed in the cartridge repository - --recursive + --recursive The source directory provided contains cartridge source directories, rather than pointing to one cartridge - --mco + --mco Use the mcollective mco agent to update the cartridge repository. - --name NAME --version VERSION --cartridge_version VERSION - When erasing a cartridge from the cartridge repository you must provide the exact version to remove. + --cartridge_vendor VENDOR --name NAME --version VERSION --cartridge_version VERSION + When erasing a cartridge from the cartridge repository you must provide the exact version to remove. 'redhat' is the + default VENDOR. + + --force + Override verifications before erasing cartridge from repository CONFIGURATION - /usr/libexec/openshift/cartridges + /usr/libexec/openshift/cartridges default source directory - /var/lib/openshift/.cartridge_repository + /var/lib/openshift/.cartridge_repository directory for storing cartridge repository EXAMPLE - # oo-admin-cartridge --action install --recursive --source /usr/libexec/openshift/cartridges + # oo-admin-cartridge --action install --recursive --source /usr/libexec/openshift/cartridges Install all current cartridges into cartridge repository - # oo-admin-cartridge --action list + # oo-admin-cartridge --action list List all versions of all cartridges install in cartridge repository - + SEE ALSO AUTHOR - Jhon Honce - man page written for OpenShift Origin + Jhon Honce - man page written for OpenShift Origin diff --git a/node-util/man8/oo-cartridge.8 b/node-util/man8/oo-cartridge.8 index 2a327046a2c..9381ad06047 100644 --- a/node-util/man8/oo-cartridge.8 +++ b/node-util/man8/oo-cartridge.8 @@ -1,13 +1,13 @@ .\" Text automatically generated by txt2man -.TH oo-cartridge 8 "14 August 2013" "" "" +.TH oo-cartridge 8 "17 July 2014" "" "" .SH NAME \fBoo-cartridge \fB .SH SYNOPSIS .nf .fam C -\fBoo-cartridge\fP \fIOPTIONS\fP \fB--with-container-uuid\fP \fILOGIN\fP \fB--action\fP \fIadd\fP \fB--with-cartridge-name\fP \fINAME\fP -\fBoo-cartridge\fP \fIOPTIONS\fP \fB--with-container-uuid\fP \fILOGIN\fP \fB--action\fP \fIdelete\fP \fB--with-cartridge-name\fP \fINAME\fP +\fBoo-cartridge\fP \fIOPTIONS\fP \fB--with-container-uuid\fP \fILOGIN\fP \fB--action\fP \fIadd\fP [\fB--with-cartridge-vendor\fP \fIVENDOR\fP] \fB--with-cartridge-name\fP \fINAME\fP +\fBoo-cartridge\fP \fIOPTIONS\fP \fB--with-container-uuid\fP \fILOGIN\fP \fB--action\fP \fIdelete\fP [\fB--with-cartridge-vendor\fP \fIVENDOR\fP] \fB--with-cartridge-name\fP \fINAME\fP .fam T .fi @@ -15,25 +15,21 @@ .fi .SH DESCRIPTION \fBoo-cartridge\fP provides OpenShift Operators the ability to \fIadd\fP or remove a cartridge from a gear. -.TP -.B +.PP This command is used for repair and development work. .SH OPTIONS \fB-u\fP| \fB--with-template-url\fP -Optional URL to provide a different template application. -.TP -.B +Optional URL to provide a different template application. +.PP \fB-h\fP|\fB--help\fP Display a simple help menu. -.TP -.B +.PP \fB-d\fP|\fB--debug\fP Provide additional output. .SH COMMANDS \fB-c\fP| \fB--with-container-uuid\fP \fILOGIN\fP -The gear login to take action against. -.TP -.B +The gear login to take action against. +.PP \fB-a\fP| \fB--action\fP ACTION .RS .TP @@ -48,17 +44,33 @@ remove named cartridge from provided gear login .PP \fB-n\fP| \fB--with-cartridge-name\fP \fINAME\fP cartridge to be added or removed -.RE .PP - +\fB-o\fP| \fB--with-cartridge-vendor\fP \fIVENDOR\fP +.RS +.TP +.B +optional cartridge vendor for cartridge to be added or removed. +Defaults to 'redhat'. .SH CONFIGURATION .SH EXAMPLE -# \fBoo-cartridge\fP \fB--with-container-uuid\fP 11223345 \fB--action\fP \fIadd\fP \fB--with-cartridge-name\fP mock-0.1 Add mock-0.1 cartridge to gear 11223345 -# \fBoo-cartridge\fP \fB--with-container-uuid\fP 11223345 \fB--action\fP remove \fB--with-cartridge-name\fP mock-0.1 +.PP +.nf +.fam C + # oo-cartridge --with-container-uuid 11223345 --action add --with-cartridge-name mock-0.1 + +.fam T +.fi Remove mock-0.1 cartridge from gear 11223345 +.PP +.nf +.fam C + # oo-cartridge --with-container-uuid 11223345 --action delete --with-cartridge-name mock-0.1 + +.fam T +.fi .SH SEE ALSO .SH AUTHOR -Jhon Honce - man page written for OpenShift Origin +Jhon Honce - man page written for OpenShift Origin diff --git a/node-util/man8/oo-cartridge.txt2man b/node-util/man8/oo-cartridge.txt2man index 6b78480bccd..a6ed9fd9df7 100644 --- a/node-util/man8/oo-cartridge.txt2man +++ b/node-util/man8/oo-cartridge.txt2man @@ -1,46 +1,51 @@ NAME oo-cartridge - + SYNOPSIS - oo-cartridge OPTIONS --with-container-uuid LOGIN --action add --with-cartridge-name NAME - oo-cartridge OPTIONS --with-container-uuid LOGIN --action delete --with-cartridge-name NAME + oo-cartridge OPTIONS --with-container-uuid LOGIN --action add [--with-cartridge-vendor VENDOR] --with-cartridge-name NAME + oo-cartridge OPTIONS --with-container-uuid LOGIN --action delete [--with-cartridge-vendor VENDOR] --with-cartridge-name NAME DESCRIPTION oo-cartridge provides OpenShift Operators the ability to add or remove a cartridge from a gear. - This command is used for repair and development work. + This command is used for repair and development work. OPTIONS -u| --with-template-url - Optional URL to provide a different template application. + Optional URL to provide a different template application. - -h|--help + -h|--help Display a simple help menu. - -d|--debug + -d|--debug Provide additional output. COMMANDS -c| --with-container-uuid LOGIN - The gear login to take action against. - - -a| --action ACTION + The gear login to take action against. + + -a| --action ACTION add add named cartridge to provided gear login delete remove named cartridge from provided gear login -n| --with-cartridge-name NAME cartridge to be added or removed - + + -o| --with-cartridge-vendor VENDOR + Optional cartridge vendor for cartridge to be added or removed. Defaults to 'redhat'. CONFIGURATION - + EXAMPLE - # oo-cartridge --with-container-uuid 11223345 --action add --with-cartridge-name mock-0.1 - Add mock-0.1 cartridge to gear 11223345 - # oo-cartridge --with-container-uuid 11223345 --action remove --with-cartridge-name mock-0.1 - Remove mock-0.1 cartridge from gear 11223345 - + Add mock-0.1 cartridge to gear 11223345 + + # oo-cartridge --with-container-uuid 11223345 --action add --with-cartridge-name mock-0.1 + + Remove mock-0.1 cartridge from gear 11223345 + + # oo-cartridge --with-container-uuid 11223345 --action delete --with-cartridge-name mock-0.1 + SEE ALSO AUTHOR - Jhon Honce - man page written for OpenShift Origin + Jhon Honce - man page written for OpenShift Origin