javaproperties

NAME

javaproperties — Basic manipulation of Java .properties files

SYNOPSIS

javaproperties get    [<OPTIONS>] <file> <key> ...
javaproperties select [<OPTIONS>] <file> <key> ...
javaproperties set    [<OPTIONS>] <file> <key> <value>
javaproperties delete [<OPTIONS>] <file> <key> ...
javaproperties format [<OPTIONS>] [<file>]

get

javaproperties get [<OPTIONS>] <file> <key> ...

Print out the values of the given keys in the given .properties file. Each value is printed out on a separate line with escape sequences interpolated.

If you want the output to also be in .properties format, see select.

Options

-d <value>, --default-value <value>

Default value for undefined keys. If this option is not specified, keys requested on the command line that are not defined in either the main .properties file or the --defaults file will (unless the --quiet option is given) cause a warning to be printed to stderr and the command to exit with a failure status.

-D <file>, --defaults <file>

.properties file of default values. If this option is specified, keys requested on the command line that are not defined in the main .properties file will be looked up in this file.

-e, --escaped

Parse the keys and default value specified on the command line for .properties-style escape sequences (specifically, those supported by javaproperties.unescape)

-E <encoding>, --encoding <encoding>

Specifies the encoding of the input file(s); default value: iso-8859-1 (a.k.a. Latin-1). Output always uses the locale’s encoding.

-q, --quiet

New in version 0.7.0.

Do not warn about or fail due to missing keys

select

javaproperties select [<OPTIONS>] <file> <key> ...

Print out the key-value entries in the given .properties file for the given keys. The output is in .properties format, reformatted as though by format.

Options

-A, --ascii

New in version 0.6.0.

Escape all non-ASCII characters in the output with \uXXXX escape sequences. This overrides --unicode. This is the default behavior.

-d <value>, --default-value <value>

Default value for undefined keys. If this option is not specified, keys requested on the command line that are not defined in either the main .properties file or the --defaults file will (unless the --quiet option is given) cause a warning to be printed to stderr and the command to exit with a failure status.

-D <file>, --defaults <file>

.properties file of default values. If this option is specified, keys requested on the command line that are not defined in the main .properties file will be looked up in this file.

-e, --escaped

Parse the keys and default value specified on the command line for .properties-style escape sequences (specifically, those supported by javaproperties.unescape)

-E <encoding>, --encoding <encoding>

Specifies the encoding of the input and output files; default value: iso-8859-1 (a.k.a. Latin-1)

-o <file>, --outfile <file>

Write output to this file instead of standard output

-s <sep>, --separator <sep>

Use <sep> as the key-value separator in the output; default value: =

-q, --quiet

New in version 0.7.0.

Do not warn about or fail due to missing keys

-U, --unicode

New in version 0.6.0.

Output non-ASCII characters literally, except for characters that are not supported by the output encoding, which are escaped with \uXXXX escape sequences. This overrides --ascii.

set

javaproperties set [<OPTIONS>] <file> <key> <value>

Set the value of <key> in the .properties file <file> to <value> and output the results. The other entries in the file (including comments, possibly not including the timestamp; see below) will be left as-is.

Options

-A, --ascii

New in version 0.6.0.

Escape all non-ASCII characters in the new key & value with \uXXXX escape sequences on output. This overrides --unicode. This is the default behavior.

-e, --escaped

Parse <key> and <value> for .properties-style escape sequences (specifically, those supported by javaproperties.unescape)

-E <encoding>, --encoding <encoding>

Specifies the encoding of the input and output files; default value: iso-8859-1 (a.k.a. Latin-1)

-o <file>, --outfile <file>

Write output to this file instead of standard output

-s <sep>, --separator <sep>

Separate <key> and <value> in the output with <sep>; default value: =

-T, --preserve-timestamp

Do not modify the timestamp in the .properties file. By default, if a timestamp is found, it is updated to the current time, even if the rest of the file is unchanged.

-U, --unicode

New in version 0.6.0.

Output non-ASCII characters in the new key & value literally, except for characters that are not supported by the output encoding, which are escaped with \uXXXX escape sequences. This overrides --ascii.

delete

javaproperties delete [<OPTIONS>] <file> <key> ...

Remove all entries for the given keys from the given .properties file and output the results. The other entries in the file (including comments, possibly not including the timestamp; see below) will be left as-is.

Options

-e, --escaped

Parse the keys specified on the command line for .properties-style escape sequences (specifically, those supported by javaproperties.unescape)

-E <encoding>, --encoding <encoding>

Specifies the encoding of the input and output files; default value: iso-8859-1 (a.k.a. Latin-1)

-o <file>, --outfile <file>

Write output to this file instead of standard output

-T, --preserve-timestamp

Do not modify the timestamp in the .properties file. By default, if a timestamp is found, it is updated to the current time, even if the rest of the file is unchanged.

format

javaproperties format [<OPTIONS>] [<file>]

Normalize the formatting of the given .properties file (or standard input if no file is given) and output the results. All comments, excess whitespace, invalid escapes, and duplicate keys are removed, and the entries are sorted lexicographically.

Options

-A, --ascii

New in version 0.6.0.

Escape all non-ASCII characters in the output with \uXXXX escape sequences. This overrides --unicode. This is the default behavior.

-E <encoding>, --encoding <encoding>

Specifies the encoding of the input and output files; default value: iso-8859-1 (a.k.a. Latin-1)

-o <file>, --outfile <file>

Write output to this file instead of standard output

-s <sep>, --separator <sep>

Use <sep> as the key-value separator in the output; default value: =

-U, --unicode

New in version 0.6.0.

Output non-ASCII characters literally, except for characters that are not supported by the output encoding, which are escaped with \uXXXX escape sequences. This overrides --ascii.