summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorrofl0r <retnyg@gmx.net>2012-09-17 05:33:45 +0200
committerrofl0r <retnyg@gmx.net>2012-09-17 05:33:45 +0200
commite79051064ec3a9c0490102b79a4cacfd49beb5bd (patch)
tree8faefb57083bca38a271c6a0187f117a4966b9fe /docs
parentbcdb2267b89cae0912e5803a87af5f0208855236 (diff)
downloadgettext-tiny-e79051064ec3a9c0490102b79a4cacfd49beb5bd.tar.gz
add some docs
Diffstat (limited to 'docs')
-rw-r--r--docs/msgfmt.txt74
-rw-r--r--docs/msgmerge.txt81
-rw-r--r--docs/xgettext.txt101
3 files changed, 256 insertions, 0 deletions
diff --git a/docs/msgfmt.txt b/docs/msgfmt.txt
new file mode 100644
index 0000000..c0147d7
--- /dev/null
+++ b/docs/msgfmt.txt
@@ -0,0 +1,74 @@
+Usage: msgfmt [OPTION] filename.po ...
+
+Generate binary message catalog from textual translation description.
+
+Mandatory arguments to long options are mandatory for short options too.
+Similarly for optional arguments.
+
+Input file location:
+ filename.po ... input files
+ -D, --directory=DIRECTORY add DIRECTORY to list for input files search
+If input file is -, standard input is read.
+
+Operation mode:
+ -j, --java Java mode: generate a Java ResourceBundle class
+ --java2 like --java, and assume Java2 (JDK 1.2 or higher)
+ --csharp C# mode: generate a .NET .dll file
+ --csharp-resources C# resources mode: generate a .NET .resources file
+ --tcl Tcl mode: generate a tcl/msgcat .msg file
+ --qt Qt mode: generate a Qt .qm file
+
+Output file location:
+ -o, --output-file=FILE write output to specified file
+ --strict enable strict Uniforum mode
+If output file is -, output is written to standard output.
+
+Output file location in Java mode:
+ -r, --resource=RESOURCE resource name
+ -l, --locale=LOCALE locale name, either language or language_COUNTRY
+ -d DIRECTORY base directory of classes directory hierarchy
+The class name is determined by appending the locale name to the resource name,
+separated with an underscore. The -d option is mandatory. The class is
+written under the specified directory.
+
+Output file location in C# mode:
+ -r, --resource=RESOURCE resource name
+ -l, --locale=LOCALE locale name, either language or language_COUNTRY
+ -d DIRECTORY base directory for locale dependent .dll files
+The -l and -d options are mandatory. The .dll file is written in a
+subdirectory of the specified directory whose name depends on the locale.
+
+Output file location in Tcl mode:
+ -l, --locale=LOCALE locale name, either language or language_COUNTRY
+ -d DIRECTORY base directory of .msg message catalogs
+The -l and -d options are mandatory. The .msg file is written in the
+specified directory.
+
+Input file syntax:
+ -P, --properties-input input files are in Java .properties syntax
+ --stringtable-input input files are in NeXTstep/GNUstep .strings
+ syntax
+
+Input file interpretation:
+ -c, --check perform all the checks implied by
+ --check-format, --check-header, --check-domain
+ --check-format check language dependent format strings
+ --check-header verify presence and contents of the header entry
+ --check-domain check for conflicts between domain directives
+ and the --output-file option
+ -C, --check-compatibility check that GNU msgfmt behaves like X/Open msgfmt
+ --check-accelerators[=CHAR] check presence of keyboard accelerators for
+ menu items
+ -f, --use-fuzzy use fuzzy entries in output
+
+Output details:
+ -a, --alignment=NUMBER align strings to NUMBER bytes (default: 1)
+ --no-hash binary file will not include the hash table
+
+Informative output:
+ -h, --help display this help and exit
+ -V, --version output version information and exit
+ --statistics print statistics about translations
+ -v, --verbose increase verbosity level
+
+Report bugs to <bug-gnu-gettext@gnu.org>.
diff --git a/docs/msgmerge.txt b/docs/msgmerge.txt
new file mode 100644
index 0000000..8688e84
--- /dev/null
+++ b/docs/msgmerge.txt
@@ -0,0 +1,81 @@
+Usage: msgmerge [OPTION] def.po ref.pot
+
+Merges two Uniforum style .po files together. The def.po file is an
+existing PO file with translations which will be taken over to the newly
+created file as long as they still match; comments will be preserved,
+but extracted comments and file positions will be discarded. The ref.pot
+file is the last created PO file with up-to-date source references but
+old translations, or a PO Template file (generally created by xgettext);
+any translations or comments in the file will be discarded, however dot
+comments and file positions will be preserved. Where an exact match
+cannot be found, fuzzy matching is used to produce better results.
+
+Mandatory arguments to long options are mandatory for short options too.
+
+Input file location:
+ def.po translations referring to old sources
+ ref.pot references to new sources
+ -D, --directory=DIRECTORY add DIRECTORY to list for input files search
+ -C, --compendium=FILE additional library of message translations,
+ may be specified more than once
+
+Operation mode:
+ -U, --update update def.po,
+ do nothing if def.po already up to date
+
+Output file location:
+ -o, --output-file=FILE write output to specified file
+The results are written to standard output if no output file is specified
+or if it is -.
+
+Output file location in update mode:
+The result is written back to def.po.
+ --backup=CONTROL make a backup of def.po
+ --suffix=SUFFIX override the usual backup suffix
+The version control method may be selected via the --backup option or through
+the VERSION_CONTROL environment variable. Here are the values:
+ none, off never make backups (even if --backup is given)
+ numbered, t make numbered backups
+ existing, nil numbered if numbered backups exist, simple otherwise
+ simple, never always make simple backups
+The backup suffix is `~', unless set with --suffix or the SIMPLE_BACKUP_SUFFIX
+environment variable.
+
+Operation modifiers:
+ -m, --multi-domain apply ref.pot to each of the domains in def.po
+ -N, --no-fuzzy-matching do not use fuzzy matching
+ --previous keep previous msgids of translated messages
+
+Input file syntax:
+ -P, --properties-input input files are in Java .properties syntax
+ --stringtable-input input files are in NeXTstep/GNUstep .strings
+ syntax
+
+Output details:
+ --lang=CATALOGNAME set 'Language' field in the header entry
+ --color use colors and other text attributes always
+ --color=WHEN use colors and other text attributes if WHEN.
+ WHEN may be 'always', 'never', 'auto', or 'html'.
+ --style=STYLEFILE specify CSS style rule file for --color
+ -e, --no-escape do not use C escapes in output (default)
+ -E, --escape use C escapes in output, no extended chars
+ --force-po write PO file even if empty
+ -i, --indent indented output style
+ --no-location suppress '#: filename:line' lines
+ --add-location preserve '#: filename:line' lines (default)
+ --strict strict Uniforum output style
+ -p, --properties-output write out a Java .properties file
+ --stringtable-output write out a NeXTstep/GNUstep .strings file
+ -w, --width=NUMBER set output page width
+ --no-wrap do not break long message lines, longer than
+ the output page width, into several lines
+ -s, --sort-output generate sorted output
+ -F, --sort-by-file sort output by file location
+
+Informative output:
+ -h, --help display this help and exit
+ -V, --version output version information and exit
+ -v, --verbose increase verbosity level
+ -q, --quiet, --silent suppress progress indicators
+
+Report bugs to <bug-gnu-gettext@gnu.org>.
diff --git a/docs/xgettext.txt b/docs/xgettext.txt
new file mode 100644
index 0000000..a356e26
--- /dev/null
+++ b/docs/xgettext.txt
@@ -0,0 +1,101 @@
+Usage: xgettext [OPTION] [INPUTFILE]...
+
+Extract translatable strings from given input files.
+
+Mandatory arguments to long options are mandatory for short options too.
+Similarly for optional arguments.
+
+Input file location:
+ INPUTFILE ... input files
+ -f, --files-from=FILE get list of input files from FILE
+ -D, --directory=DIRECTORY add DIRECTORY to list for input files search
+If input file is -, standard input is read.
+
+Output file location:
+ -d, --default-domain=NAME use NAME.po for output (instead of messages.po)
+ -o, --output=FILE write output to specified file
+ -p, --output-dir=DIR output files will be placed in directory DIR
+If output file is -, output is written to standard output.
+
+Choice of input file language:
+ -L, --language=NAME recognise the specified language
+ (C, C++, ObjectiveC, PO, Shell, Python, Lisp,
+ EmacsLisp, librep, Scheme, Smalltalk, Java,
+ JavaProperties, C#, awk, YCP, Tcl, Perl, PHP,
+ GCC-source, NXStringTable, RST, Glade)
+ -C, --c++ shorthand for --language=C++
+By default the language is guessed depending on the input file name extension.
+
+Input file interpretation:
+ --from-code=NAME encoding of input files
+ (except for Python, Tcl, Glade)
+By default the input files are assumed to be in ASCII.
+
+Operation mode:
+ -j, --join-existing join messages with existing file
+ -x, --exclude-file=FILE.po entries from FILE.po are not extracted
+ -cTAG, --add-comments=TAG place comment blocks starting with TAG and
+ preceding keyword lines in output file
+ -c, --add-comments place all comment blocks preceding keyword lines
+ in output file
+
+Language specific options:
+ -a, --extract-all extract all strings
+ (only languages C, C++, ObjectiveC, Shell,
+ Python, Lisp, EmacsLisp, librep, Scheme, Java,
+ C#, awk, Tcl, Perl, PHP, GCC-source, Glade)
+ -kWORD, --keyword=WORD look for WORD as an additional keyword
+ -k, --keyword do not to use default keywords
+ (only languages C, C++, ObjectiveC, Shell,
+ Python, Lisp, EmacsLisp, librep, Scheme, Java,
+ C#, awk, Tcl, Perl, PHP, GCC-source, Glade)
+ --flag=WORD:ARG:FLAG additional flag for strings inside the argument
+ number ARG of keyword WORD
+ (only languages C, C++, ObjectiveC, Shell,
+ Python, Lisp, EmacsLisp, librep, Scheme, Java,
+ C#, awk, YCP, Tcl, Perl, PHP, GCC-source)
+ -T, --trigraphs understand ANSI C trigraphs for input
+ (only languages C, C++, ObjectiveC)
+ --qt recognize Qt format strings
+ (only language C++)
+ --kde recognize KDE 4 format strings
+ (only language C++)
+ --boost recognize Boost format strings
+ (only language C++)
+ --debug more detailed formatstring recognition result
+
+Output details:
+ --color use colors and other text attributes always
+ --color=WHEN use colors and other text attributes if WHEN.
+ WHEN may be 'always', 'never', 'auto', or 'html'.
+ --style=STYLEFILE specify CSS style rule file for --color
+ -e, --no-escape do not use C escapes in output (default)
+ -E, --escape use C escapes in output, no extended chars
+ --force-po write PO file even if empty
+ -i, --indent write the .po file using indented style
+ --no-location do not write '#: filename:line' lines
+ -n, --add-location generate '#: filename:line' lines (default)
+ --strict write out strict Uniforum conforming .po file
+ --properties-output write out a Java .properties file
+ --stringtable-output write out a NeXTstep/GNUstep .strings file
+ -w, --width=NUMBER set output page width
+ --no-wrap do not break long message lines, longer than
+ the output page width, into several lines
+ -s, --sort-output generate sorted output
+ -F, --sort-by-file sort output by file location
+ --omit-header don't write header with `msgid ""' entry
+ --copyright-holder=STRING set copyright holder in output
+ --foreign-user omit FSF copyright in output for foreign user
+ --package-name=PACKAGE set package name in output
+ --package-version=VERSION set package version in output
+ --msgid-bugs-address=EMAIL@ADDRESS set report address for msgid bugs
+ -m[STRING], --msgstr-prefix[=STRING] use STRING or "" as prefix for msgstr
+ values
+ -M[STRING], --msgstr-suffix[=STRING] use STRING or "" as suffix for msgstr
+ values
+
+Informative output:
+ -h, --help display this help and exit
+ -V, --version output version information and exit
+
+Report bugs to <bug-gnu-gettext@gnu.org>.