cert.py split module docstring to multiple ugetext string

It is hard to translate whole dosctring again and again aftear each
minor change. This split will make life for translators easier. (Just note: dosctring was
changed and that is the reason why I'm sending this, because translators
must translate it again anyway)

Reviewed-By: Stanislav Laznicka <slaznick@redhat.com>
This commit is contained in:
Martin Basti 2016-06-29 17:49:47 +02:00
parent a155f692e7
commit fed9d9aaa7

View File

@ -56,89 +56,89 @@ if six.PY3:
__doc__ = _(""" __doc__ = _("""
IPA certificate operations IPA certificate operations
""") + _("""
Implements a set of commands for managing server SSL certificates. Implements a set of commands for managing server SSL certificates.
""") + _("""
Certificate requests exist in the form of a Certificate Signing Request (CSR) Certificate requests exist in the form of a Certificate Signing Request (CSR)
in PEM format. in PEM format.
""") + _("""
The dogtag CA uses just the CN value of the CSR and forces the rest of the The dogtag CA uses just the CN value of the CSR and forces the rest of the
subject to values configured in the server. subject to values configured in the server.
""") + _("""
A certificate is stored with a service principal and a service principal A certificate is stored with a service principal and a service principal
needs a host. needs a host.
""") + _("""
In order to request a certificate: In order to request a certificate:
""") + _("""
* The host must exist * The host must exist
* The service must exist (or you use the --add option to automatically add it) * The service must exist (or you use the --add option to automatically add it)
""") + _("""
SEARCHING: SEARCHING:
""") + _("""
Certificates may be searched on by certificate subject, serial number, Certificates may be searched on by certificate subject, serial number,
revocation reason, validity dates and the issued date. revocation reason, validity dates and the issued date.
""") + _("""
When searching on dates the _from date does a >= search and the _to date When searching on dates the _from date does a >= search and the _to date
does a <= search. When combined these are done as an AND. does a <= search. When combined these are done as an AND.
""") + _("""
Dates are treated as GMT to match the dates in the certificates. Dates are treated as GMT to match the dates in the certificates.
""") + _("""
The date format is YYYY-mm-dd. The date format is YYYY-mm-dd.
""") + _("""
EXAMPLES: EXAMPLES:
""") + _("""
Request a new certificate and add the principal: Request a new certificate and add the principal:
ipa cert-request --add --principal=HTTP/lion.example.com example.csr ipa cert-request --add --principal=HTTP/lion.example.com example.csr
""") + _("""
Retrieve an existing certificate: Retrieve an existing certificate:
ipa cert-show 1032 ipa cert-show 1032
""") + _("""
Revoke a certificate (see RFC 5280 for reason details): Revoke a certificate (see RFC 5280 for reason details):
ipa cert-revoke --revocation-reason=6 1032 ipa cert-revoke --revocation-reason=6 1032
""") + _("""
Remove a certificate from revocation hold status: Remove a certificate from revocation hold status:
ipa cert-remove-hold 1032 ipa cert-remove-hold 1032
""") + _("""
Check the status of a signing request: Check the status of a signing request:
ipa cert-status 10 ipa cert-status 10
""") + _("""
Search for certificates by hostname: Search for certificates by hostname:
ipa cert-find --subject=ipaserver.example.com ipa cert-find --subject=ipaserver.example.com
""") + _("""
Search for revoked certificates by reason: Search for revoked certificates by reason:
ipa cert-find --revocation-reason=5 ipa cert-find --revocation-reason=5
""") + _("""
Search for certificates based on issuance date Search for certificates based on issuance date
ipa cert-find --issuedon-from=2013-02-01 --issuedon-to=2013-02-07 ipa cert-find --issuedon-from=2013-02-01 --issuedon-to=2013-02-07
""") + _("""
Search for certificates owned by a specific user: Search for certificates owned by a specific user:
ipa cert-find --user=user ipa cert-find --user=user
""") + _("""
Examine a certificate: Examine a certificate:
ipa cert-find --file=cert.pem --all ipa cert-find --file=cert.pem --all
""") + _("""
Verify that a certificate is owner by a specific user: Verify that a certificate is owner by a specific user:
ipa cert-find --file=cert.pem --user=user ipa cert-find --file=cert.pem --user=user
""") + _("""
IPA currently immediately issues (or declines) all certificate requests so IPA currently immediately issues (or declines) all certificate requests so
the status of a request is not normally useful. This is for future use the status of a request is not normally useful. This is for future use
or the case where a CA does not immediately issue a certificate. or the case where a CA does not immediately issue a certificate.
""") + _("""
The following revocation reasons are supported: The following revocation reasons are supported:
* 0 - unspecified """) + _(""" * 0 - unspecified
* 1 - keyCompromise """) + _(""" * 1 - keyCompromise
* 2 - cACompromise """) + _(""" * 2 - cACompromise
* 3 - affiliationChanged """) + _(""" * 3 - affiliationChanged
* 4 - superseded """) + _(""" * 4 - superseded
* 5 - cessationOfOperation """) + _(""" * 5 - cessationOfOperation
* 6 - certificateHold """) + _(""" * 6 - certificateHold
* 8 - removeFromCRL """) + _(""" * 8 - removeFromCRL
* 9 - privilegeWithdrawn """) + _(""" * 9 - privilegeWithdrawn
* 10 - aACompromise """) + _(""" * 10 - aACompromise
""") + _("""
Note that reason code 7 is not used. See RFC 5280 for more details: Note that reason code 7 is not used. See RFC 5280 for more details:
""") + _("""
http://www.ietf.org/rfc/rfc5280.txt http://www.ietf.org/rfc/rfc5280.txt
""") """)