File google-java-format.pod of Package google-java-format

Overview Repositories Revisions Requests Users Attributes Meta

File google-java-format.pod of Package google-java-format

=encoding utf8

=head1 NAME

google-java-format - reformats Java source code to comply with Google Java Style

=head1 SYNOPSIS

google-java-format [I<options>] I<file>…

=head1 DESCRIPTION

B<google-java-format> is a program that reformats Java source code to comply with Google Java Style.

The formatter can act on whole files, on limited lines (B<--lines>), on specific
offsets (B<--offset>), passing through to standard-out (default) or altered
in-place (B<--replace>).

=head1 OPTIONS

=over

=item B<-i>, B<-r>, B<-replace>, B<--replace>

Send formatted output back to files, not stdout.

=item B<->

Format stdin -> stdout

=item B<--assume-filename>, B<-assume-filename>

File name to use for diagnostics when formatting standard input (default is <stdin>).

=item B<--aosp>, B<-aosp>, B<-a>

Use AOSP style instead of Google Style (4-space indentation).

=item B<--fix-imports-only>

Fix import order and remove any unused imports, but do no other formatting.

=item B<--skip-sorting-imports>

Do not fix the import order. Unused imports will still be removed.

=item B<--skip-removing-unused-imports>

Do not remove unused imports. Imports will still be sorted.

=item B<--skip-reflowing-long-strings>

Do not reflow string literals that exceed the column limit.

=item B<--skip-javadoc-formatting>

Do not reformat javadoc.

=item B<--dry-run>, B<-n>

Prints the paths of the files whose contents would change if the formatter were run normally.

=item B<--set-exit-if-changed>

Return exit code 1 if there are any formatting changes.

=item B<--lines>, B<-lines>, B<--line>, B<-line>

Line range(s) to format, like 5:10 (1-based; default is all).

=item B<--offset>, B<-offset>

Character offset to format (0-based; default is all).

=item B<--length>, B<-length>

Character length to format.

=item B<--help>, B<-help>, B<-h>

Print this usage statement.

=item B<--version>, B<-version>, B<-v>

Print the version.

=item B<@>I<filename>

Read options and filenames from file.

=back

If B<-i> is given with B<->, the result is sent to stdout.

The B<--lines>, B<--offset>, and B<--length> flags may be given more than once.

The B<--offset> and B<--length> flags must be given an equal number of times.

If B<--lines>, B<--offset>, or B<--length> are given, only one file (or B<->) may be given.

=head1 LICENSE

Released under version 2.0 of the L<Apache
License|https://www.apache.org/licenses/LICENSE-2.0.txt>.

=head1 SEE ALSO

L<https://github.com/google/google-java-format>

Places

File google-java-format.pod of Package google-java-format

Places