Merge pull request #1385 from davvid/bindir
[git-cola.git] / docs / git-dag.rst
blobc6a7eefe1db40625bcc2198177b1783dc6f685a9
1 =======
2 git-dag
3 =======
5 SYNOPSIS
6 ========
7 ``git dag [options] [<revision-range>] [[--] [<path>...]]``
10 DESCRIPTION
11 ===========
12 `git-dag` is an advanced Git history visualizer that presents ``git log``'s
13 powerful features in an easy to use graphical interface.
16 OPTIONS
17 =======
18 ``<revision-range>``
19 --------------------
20 Show only commits in the specified revision range.
21 When no ``<revision-range>`` is specified, it defaults to ``HEAD``
22 (i.e. the whole history leading to the current commit).
24 ``origin..HEAD`` specifies all the commits reachable from the current commit
25 (i.e.  ``HEAD``), but not from ``origin``.
27 For a complete list of ways to spell ``<revision-range>``, see the Specifying Ranges
28 section of `gitrevisions(7) <https://git-scm.com/docs/gitrevisions>`_
29 (``man gitrevisions``).
32 ``--prompt``
33 ------------
34 Prompt for a Git repository instead of using the current directory.
36 ``-r, --repo <path>``
37 ---------------------
38 Open the git repository located at ``<path>``.
39 Defaults to the current directory.
41 ``--version``
42 -------------
43 Print the version number and exit.
45 ``-h, --help``
46 --------------
47 Show usage and optional arguments.
50 Log Arguments
51 =============
52 The ``Log`` text field allows you to pass arguments to `git log`.
53 This can be used to filter the displayed history, for example
54 entering `main -- Makefile` will display only commits on the
55 `main` branch that touch the `Makefile`.
57 The `Log` text field lets you interactively edit and replace the
58 ``[<revision-range>] [[--] [<path>...]]`` arguments that were initially
59 specified on the command-line.
61 CONTEXT-MENU ACTIONS
62 ====================
63 The right-click menu can be used to perform various actions.
64 All actions operate on the selected commit.
66 You can create branches and tags, cherry-pick commits, save patches,
67 export tarballs, and grab files from older commits using the context menu.
69 DIFF COMMITS
70 ============
71 You can diff arbitrary commits.  Select a single commit in either the list
72 view or the graph view and then right-click on a second commit.
74 A menu will appear allowing you to diff the two commits.
76 SHORTCUTS
77 =========
78 You can run commands using dedicated shortcuts. Select a single commit
79 and then press `Ctrl-Alt-c` to copy sha1 or `Ctrl-d` to run diff tool.
81 You can read more about hotkeys from 'keyboard shortcuts' window or context menu.
83 CONFIGURATION VARIABLES
84 =======================
86 log.date
87 --------
88 Set the default date-time format for the 'Date' field.
89 Setting a value for log.date is similar to using `git log`'s
90 `--date` option.  Possible values are `relative`, `local`,
91 `default`, `iso`, `rfc`, and `short`; see git-log(1) for details.