.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
.TH kim-api-v2-collections-management "24" "August 2018" "kim-api-v2-collections-management: --version" "User Commands"
.SH NAME
kim-api-v2-collections-management \- provides information regarding the models and model drivers
.SH DESCRIPTION
This utility provides information regarding the models and model drivers
installed in each of the four collections defined by the kim-api package. The
utility also provides the ability to build and install/remove models and
drivers if the kim-api development package has been installed.\fR
.SS "Usage:"
.IP
kim\-api\-v2\-collections\-management list [\-\-with\-version] [\-\-log]
kim\-api\-v2\-collections\-management set\-user\-models\-dir <directory>
kim\-api\-v2\-collections\-management set\-user\-drivers\-dir <directory>
kim\-api\-v2\-collections\-management install [\-\-force]
.IP
(CWD | environment | user | system [\-\-sudo])
(<openkim\-item\-id>... | <local\-item\-path>... | OpenKIM |
.IP
OpenKIM_with_history)
.IP
kim\-api\-v2\-collections\-management reinstall [\-\-interacitive] [\-\-sudo]
.IP
(<openkim\-item\-id> | <local\-item\-path>)...
.IP
kim\-api\-v2\-collections\-management remove [\-\-interactive] [\-\-sudo] <item\-id>...
kim\-api\-v2\-collections\-management remove\-all [\-\-interactive] [\-\-sudo]
.SS "list:"
.IP
List installed kim\-api models and model drivers
.IP
* '\-\-with\-version' print the kim\-api version used to compiled the item.
* '\-\-log' generate a kim.log file.  This will show any errors that
.IP
occur as the utility searches for installed items.
.SS "set-user-models-dir:"
.IP
Rewrite configuration file with provided directory
.SS "set-user-drivers-dir:"
.IP
Rewrite configuration file with provided directory
.SS "install:"
Install model and/or model driver from openkim.org or from a local path
* Installing to the environment collection places items in the first
directory of the list.)
* 'install \fB\-\-force\fR' is essentially equivalent to 'reinstall', but works
even when the item is not currently installed.
* 'OpenKIM' installs all 'current' items found at openkim.org,
.IP
whereas 'OpenKIM_with_history' installs all 'current'
and all 'old' items.
.SS "reinstall:"
.IP
Remove and reinstall items.
WARNING: This will remove and reinstall the entire directory of files
.IP
associated with the item.
.SS "remove:"
.IP
Remove model or model driver.
WARNING: This will remove the entire directory of files associated
.IP
with the item.
.SS "remove-all:"
.IP
Remove all items from all collections.
WARNING: This will remove the entire directory of files associated
.IP
with all items.
.SS "Usage:"
.IP
kim\-api\-v2\-collections\-management list [\-\-with\-version] [\-\-log]
kim\-api\-v2\-collections\-management set\-user\-models\-dir <directory>
kim\-api\-v2\-collections\-management set\-user\-drivers\-dir <directory>
kim\-api\-v2\-collections\-management install [\-\-force]
.IP
(CWD | environment | user | system [\-\-sudo])
(<openkim\-item\-id>... | <local\-item\-path>... | OpenKIM |
.IP
OpenKIM_with_history)
.IP
kim\-api\-v2\-collections\-management reinstall [\-\-interacitive] [\-\-sudo]
.IP
(<openkim\-item\-id> | <local\-item\-path>)...
.IP
kim\-api\-v2\-collections\-management remove [\-\-interactive] [\-\-sudo] <item\-id>...
kim\-api\-v2\-collections\-management remove\-all [\-\-interactive] [\-\-sudo]
.SS "list:"
.IP
List installed kim\-api models and model drivers
.IP
* '\-\-with\-version' print the kim\-api version used to compiled the item.
* '\-\-log' generate a kim.log file.  This will show any errors that
.IP
occur as the utility searches for installed items.
.SS "set-user-models-dir:"
.IP
Rewrite configuration file with provided directory
.SS "set-user-drivers-dir:"
.IP
Rewrite configuration file with provided directory
.SS "install:"
.IP
Install model and/or model driver from openkim.org or from a local path
.IP
* Installing to the environment collection places items in the first
.IP
directory of the list.)
.IP
* 'install \fB\-\-force\fR' is essentially equivalent to 'reinstall', but works
.IP
even when the item is not currently installed.
.IP
* 'OpenKIM' installs all 'current' items found at openkim.org,
.IP
whereas 'OpenKIM_with_history' installs all 'current'
and all 'old' items.
.SS "reinstall:"
.IP
Remove and reinstall items.
WARNING: This will remove and reinstall the entire directory of files
.IP
associated with the item.
.SS "remove:"
.IP
Remove model or model driver.
WARNING: This will remove the entire directory of files associated
.IP
with the item.
.SS "remove-all:"
.IP
Remove all items from all collections.
WARNING: This will remove the entire directory of files associated
.IP
with all items.
.SH "SEE ALSO"
The full documentation for
.B kim-api-v2-collections-management
is maintained as a Texinfo manual.  If the
.B info
and
.B kim-api-v2-collections-management
programs are properly installed at your site, the command
.IP
.B info kim-api-v2-collections-management
.PP
should give you access to the complete manual.