1
0
mirror of https://git.tukaani.org/xz.git synced 2025-03-31 21:00:55 +00:00

Docs: Add a few TRANSLATORS comments to man pages

All translators know that --command-line-options must not be translated.
With some other strings it's not obvious when the untranslated string
must be preserved. These comments hopefully help.
This commit is contained in:
Lasse Collin 2025-03-06 17:37:39 +02:00
parent 051de255f0
commit 808f05af3e
No known key found for this signature in database
GPG Key ID: 38EE757D69184620
2 changed files with 24 additions and 0 deletions

View File

@ -53,6 +53,8 @@ It is deprecated and will be removed in a future version.
. .
.SH ENVIRONMENT .SH ENVIRONMENT
.TP .TP
.\" TRANSLATORS: Don't translate the uppercase PAGER.
.\" It is a name of an environment variable.
.B PAGER .B PAGER
If If
.B PAGER .B PAGER

View File

@ -237,6 +237,8 @@ The memory usage limiter can be enabled with
the command line option \fB\-\-memlimit=\fIlimit\fR. the command line option \fB\-\-memlimit=\fIlimit\fR.
Often it is more convenient to enable the limiter Often it is more convenient to enable the limiter
by default by setting the environment variable by default by setting the environment variable
.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS.
.\" It's a name of an environment variable.
.BR XZ_DEFAULTS , .BR XZ_DEFAULTS ,
for example, for example,
.BR XZ_DEFAULTS=\-\-memlimit=150MiB . .BR XZ_DEFAULTS=\-\-memlimit=150MiB .
@ -575,6 +577,7 @@ Specify the file
to compress or decompress: to compress or decompress:
.RS .RS
.TP .TP
.\" TRANSLATORS: Don't translate bold string B<auto>.
.B auto .B auto
This is the default. This is the default.
When compressing, When compressing,
@ -661,6 +664,9 @@ Supported
types: types:
.RS .RS
.TP .TP
.\" TRANSLATORS: Don't translate the bold strings B<none>, B<crc32>,
.\" B<crc64>, and B<sha256>. The command line option --check accepts
.\" only the untranslated strings.
.B none .B none
Don't calculate an integrity check at all. Don't calculate an integrity check at all.
This is usually a bad idea. This is usually a bad idea.
@ -1497,6 +1503,11 @@ LZMA1 and LZMA2 share the same set of
.IR options : .IR options :
.RS .RS
.TP .TP
.\" TRANSLATORS: Don't translate bold strings like B<preset>, B<dict>,
.\" B<mode>, B<nice>, B<fast>, or B<normal> because those are command line
.\" options. On the other hand, do translate the italic strings like
.\" I<preset>, I<size>, and I<mode>, because such italic strings are
.\" placeholders which a user replaces with an actual value.
.BI preset= preset .BI preset= preset
Reset all LZMA1 or LZMA2 Reset all LZMA1 or LZMA2
.I options .I options
@ -2147,6 +2158,11 @@ uses tab-separated output.
The first column of every line has a string The first column of every line has a string
that indicates the type of the information found on that line: that indicates the type of the information found on that line:
.TP .TP
.\" TRANSLATORS: The bold strings B<name>, B<file>, B<stream>, B<block>,
.\" B<summary>, and B<totals> are produced by the xz tool for scripts to
.\" parse, thus the untranslated strings must be included in the translated
.\" man page. It may be useful to provide a translated string in parenthesis
.\" without bold, for example: "B<name> (nimi)"
.B name .B name
This is always the first line when starting to list a file. This is always the first line when starting to list a file.
The second column on the line is the filename. The second column on the line is the filename.
@ -2225,6 +2241,9 @@ are displayed instead of the ratio.
.IP 7. 4 .IP 7. 4
Comma-separated list of integrity check names. Comma-separated list of integrity check names.
The following strings are used for the known check types: The following strings are used for the known check types:
.\" TRANSLATORS: Don't translate the bold strings B<None>, B<CRC32>,
.\" B<CRC64>, B<SHA-256>, or B<Unknown-> here. In robot mode, xz produces
.\" them in untranslated form for scripts to parse.
.BR None , .BR None ,
.BR CRC32 , .BR CRC32 ,
.BR CRC64 , .BR CRC64 ,
@ -2511,6 +2530,7 @@ prints the version number of
.B xz .B xz
and liblzma in the following format: and liblzma in the following format:
.PP .PP
.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION.
.BI XZ_VERSION= XYYYZZZS .BI XZ_VERSION= XYYYZZZS
.br .br
.BI LIBLZMA_VERSION= XYYYZZZS .BI LIBLZMA_VERSION= XYYYZZZS
@ -2565,6 +2585,8 @@ don't affect the exit status.
.B xz .B xz
parses space-separated lists of options parses space-separated lists of options
from the environment variables from the environment variables
.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT.
.\" They are names of environment variables.
.B XZ_DEFAULTS .B XZ_DEFAULTS
and and
.BR XZ_OPT , .BR XZ_OPT ,