Fix documentation

This commit is contained in:
Sebastian Meyer 2021-07-26 18:47:48 +02:00
parent f0f712d06c
commit 71c162565f
1 changed files with 32 additions and 1 deletions

View File

@ -82,6 +82,17 @@ The command `kitodo:index` is used for indexing a single document::
:Example:
123 or 'dlfCore1'
- :Option:
``-o|--owner``
:Required:
no
:Description:
This may be the UID of the library record in `tx_dlf_libraries` which
should be set as the owner of the document. If omitted, the default is
to try to read the ownership from the metadata field "owner".
:Example:
123
- :Option:
``--dry-run``
:Required:
@ -101,6 +112,14 @@ The command `kitodo:index` is used for indexing a single document::
success and 1 on failure.
:Example:
- :Option:
``-v|--verbose``
:Required:
no
:Description:
Show processed documents uid and location with indexing parameters.
:Example:
Reindex collections
-------------------
@ -169,6 +188,17 @@ collections or even to reindex all documents on the given page.::
:Example:
123 or 'dlfCore1'
- :Option:
``-o|--owner``
:Required:
no
:Description:
This may be the UID of the library record in `tx_dlf_libraries` which
should be set as the owner of the documents. If omitted, the default is
to try to read the ownership from the metadata field "owner".
:Example:
123
- :Option:
``--dry-run``
:Required:
@ -228,7 +258,8 @@ OAI-PMH base URL (e.g. https://digital.slub-dresden.de/oai/).
yes
:Description:
This is the UID of the library record with the OAI interface that
should be harvested.
should be harvested. This library is also automatically set as the
documents' owner.
:Example:
123