]>
Commit | Line | Data |
---|---|---|
2c31a830 NTND |
1 | guitool.<name>.cmd:: |
2 | Specifies the shell command line to execute when the corresponding item | |
3 | of the linkgit:git-gui[1] `Tools` menu is invoked. This option is | |
4 | mandatory for every tool. The command is executed from the root of | |
5 | the working directory, and in the environment it receives the name of | |
6 | the tool as `GIT_GUITOOL`, the name of the currently selected file as | |
7 | 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if | |
8 | the head is detached, 'CUR_BRANCH' is empty). | |
9 | ||
10 | guitool.<name>.needsFile:: | |
11 | Run the tool only if a diff is selected in the GUI. It guarantees | |
12 | that 'FILENAME' is not empty. | |
13 | ||
14 | guitool.<name>.noConsole:: | |
15 | Run the command silently, without creating a window to display its | |
16 | output. | |
17 | ||
18 | guitool.<name>.noRescan:: | |
19 | Don't rescan the working directory for changes after the tool | |
20 | finishes execution. | |
21 | ||
22 | guitool.<name>.confirm:: | |
23 | Show a confirmation dialog before actually running the tool. | |
24 | ||
25 | guitool.<name>.argPrompt:: | |
26 | Request a string argument from the user, and pass it to the tool | |
27 | through the `ARGS` environment variable. Since requesting an | |
28 | argument implies confirmation, the 'confirm' option has no effect | |
29 | if this is enabled. If the option is set to 'true', 'yes', or '1', | |
30 | the dialog uses a built-in generic prompt; otherwise the exact | |
31 | value of the variable is used. | |
32 | ||
33 | guitool.<name>.revPrompt:: | |
34 | Request a single valid revision from the user, and set the | |
35 | `REVISION` environment variable. In other aspects this option | |
36 | is similar to 'argPrompt', and can be used together with it. | |
37 | ||
38 | guitool.<name>.revUnmerged:: | |
39 | Show only unmerged branches in the 'revPrompt' subdialog. | |
40 | This is useful for tools similar to merge or rebase, but not | |
41 | for things like checkout or reset. | |
42 | ||
43 | guitool.<name>.title:: | |
44 | Specifies the title to use for the prompt dialog. The default | |
45 | is the tool name. | |
46 | ||
47 | guitool.<name>.prompt:: | |
48 | Specifies the general prompt string to display at the top of | |
49 | the dialog, before subsections for 'argPrompt' and 'revPrompt'. | |
50 | The default value includes the actual command. |