diff options
| author | Will Thompson <[email protected]> | 2017-11-14 15:30:34 +0000 |
|---|---|---|
| committer | Werner Koch <[email protected]> | 2017-11-15 07:59:12 +0000 |
| commit | 49635b454b010ec63a30b104af48a49504af7753 (patch) | |
| tree | 321af66d9a59b191c57c71e8161bfccaf61ad94c | |
| parent | gpg: Print AKL info only in verbose mode. (diff) | |
| download | gnupg-49635b454b010ec63a30b104af48a49504af7753.tar.gz gnupg-49635b454b010ec63a30b104af48a49504af7753.zip | |
doc: expand documentation of PROGRESS message
--
This answers two questions that I was only able to answer by examining
each site where PROGRESS messages are emitted, and fixes a typo.
Signed-off-by: Will Thompson <[email protected]>
Diffstat (limited to '')
| -rw-r--r-- | doc/DETAILS | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/DETAILS b/doc/DETAILS index 0be55f4d6..e683e90a2 100644 --- a/doc/DETAILS +++ b/doc/DETAILS @@ -1041,15 +1041,16 @@ pkd:0:1024:B665B1435F4C2 .... FF26ABB: - 4 :: Key is stored on a smartcard. *** PROGRESS <what> <char> <cur> <total> [<units>] - Used by the primegen and Public key functions to indicate + Used by the primegen and public key functions to indicate progress. <char> is the character displayed with no --status-fd enabled, with the linefeed replaced by an 'X'. <cur> is the current amount done and <total> is amount to be done; a <total> of - 0 indicates that the total amount is not known. The condition + 0 indicates that the total amount is not known. Both are + non-negative integers. The condition : TOTAL && CUR == TOTAL may be used to detect the end of an operation. - Well known values for WHAT are: + Well known values for <what> are: - pk_dsa :: DSA key generation - pk_elg :: Elgamal key generation @@ -1064,7 +1065,9 @@ pkd:0:1024:B665B1435F4C2 .... FF26ABB: the data of a smartcard. - card_busy :: A smartcard is still working - <units> is sometines used to describe the units for <current> and + When <what> refers to a file path, it may be truncated. + + <units> is sometimes used to describe the units for <current> and <total>. For example "B", "KiB", or "MiB". *** BACKUP_KEY_CREATED <fingerprint> <fname> |