USAGE:
java -jar QuickRev.jar [OPTIONS]
OPTIONS:
[-h|--help]
Shows this help.
[-v|--version]
Shows the current version.
[--history]
Creates / updates the QuickRev-History.
Use 'QuickRev.jar --history --help' to show all options.
[--board]
Creates the QuickRevBoard which shows open tasks and the review history of all files.
Use 'QuickRev.jar --board --help' to show all options.
[<file...>]
Loads the given project-, review- or export- files.
QuickRev determines automatically which type of file was given.
To specify the file types explicitly use the options below.
[-c|--config <config-file...>]
Start with configuration files.
The config-files can be given as local or remote (http://) files.
[-d|--diff]
Start in diff mode. The diff mode is just to perform file diffs without saving/loading of projects.
In difference to normal mode, files which are not under version control as well as local working
copies can be loaded into QuickRev and compared, which is not possible in review mode.
[-f|--file <review-file...>]
Loads the given review files.
If given as first arguments the option can be omitted.
[-p|--project <project-file...>]
Loads the given project- or export- files.
If given as first arguments the option can be omitted.
[-find|--find-project <path>]
Searches for project files which are not finished for the current user starting from the given path.
If projects are found a list will be shown to select the project which has to be loaded.
[-cs|--changeset [<rev|from-rev:to-rev|HEAD>]]
Opens the 'Add Files From Changesets' dialog and loads the given changesets (for SVN and GIT only).
Either use a single revision number to load this changeset (e.g. -cs 123) or specify a range of changesets
in the format '<from-revision>:<to-revision>' (e.g. -cs 123:126), including the given revision numbers.
Use '<from-revision>:HEAD' to load all changesets from the given revision number up to the HEAD revision.
To load the latest changesets either use 'HEAD' or no revision number at all.
The repository url will be determined from the current working directory.
Loading a range of revision numbers ('<from-revision>:<to-revision>') is not available for GIT.
Note: When loading projects or review files at the same time this option will be ignored.
[-cl|--checklist <checklist-file...>]
Loads the given checklist files.
The checklist-files can be given as local or remote (http://) files.
[--git-log-follow]
Uses 'git log --follow' for determination of file history (this is the default).
[--git-log-c]
Uses 'git log -c' for determination of file history.
[--git-log-m]
Uses 'git log -m' for determination of file history.
[--git-log=<options>]
Uses 'git log' with the given options.
Multiple space separated commands must either be quoted or can be concatenated with a '+' instead of the space.
Example: --git-log="--full-history --simplify-merges" or --git-log=--full-history+--simplify-merges
[--auto-gen-reviews]
Depending on the used git log options (default '--follow') the history of a file after renaming the file is shown or not.
This can lead to situations, where a review made for a file before renaming the file cannot be assigned to the file anymore.
If, for showing the review history (or generation of the QuickRevBoard), a review was found, where the latest known commit
of a file is part of the file history, but the base version is not part of the file history anymore, QuickRev searches for
other reviews where the SHA1 hash of the latest review version is the same as the former base version, this is done until
a 'full' review was found - so the initial review version can be marked as 'completely' reviewed.
[--db-dir <db-dir>]
Defines the directory where the history-DB is stored.
If this option is omitted the database will be stored in '~/.quickRev/history'.
[--plugin <plugin-path...>]
Specifies the plugins to be loaded.
The given paths can be either plugin jar-files or directories.
If a directory was given it will be searched for jar-files (non-recursive).
The plugin-paths can be given as local or remote (http://) once.
If plugins from remote are specified the plugins have to be listed explicitly (no directories).
[--style=<style-name[;options]>]
Defines which style to be used as look and feel.
style-name: the name of the style to use followed by optional settings of style flags.
To see all available look and feels make use of the --style-dump option.
To use the built-in dark style use --style=dark (see EXPERIMENTAL below)
Examples:
--style=dark # use dark style
--style=dark;text:#ff0000;QuickRev.base.color.green:#00fe00 # use dark style with some special color settings
EXPERIMENTAL:
The 'dark' style mode is in an experimental state so not all colors have been configured sufficiently.
For full support of the 'dark' style you can define your own color schema via the style options.
If there are fields which cannot be styled individually don't hesitate to contact me, furthermore,
if you have a completely styled dark mode schema, you can sent it to me to integrate it into QuickRev if you like.
[--style-dump[=<L&F-name>]]
Prints all available look and feel names if used without L&F-name.
Prints all available color settings of the given look and feel when a L&F-name is given
[--server[:<port>]]
Starts the HTTP server during startup with default port 8000
listening at <a>http://localhost:8000/quickrev</a>.
To change the port add a different port number like this "--server:3000".
Open the link in a browser when server is running to get help about the REST API.
[--debug[:<WARNING|INFO|CONFIG|FINE|FINER|FINEST|ALL>]]
This option is useful in case of errors to get additional information.
Specifying "--debug" only, will show an additional "Debug" menu which provides different debug options.
Furthermore you can assign a log-level in the form "--debug:ALL" to print logging information of the
given level to standard error. The following log-levels are available:
SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value), ALL.
(See java.util.logging.Level for more information)