man1/aur-view.1

   1 .TH AUR-VIEW 1 2022-10-04 AURUTILS
   2 .SH NAME
   3 aur\-view \- inspect git repositories
   4 .
   5 .SH SYNOPSIS
   6 .SY "aur view"
   7 .OP \-a arg_file
   8 .OP \-\-format
   9 .IR repository ...
  10 .YS
  11 .
  12 .SH DESCRIPTION
  13 .B aur\-view
  14 presents
  15 .BR git (1)
  16 repositories stored in a common directory for inspection. Only
  17 repositories whose names match
  18 .BR aur\-view
  19 arguments are shown.
  20 .PP
  21 The used file manager or pager is determined in the following order:
  22 .IP \(bu 4
  23 The value of
  24 .BR AUR_PAGER ", "
  25 if defined;
  26 .IP \(bu 4
  27 .BR vifm "(1), "
  28 if installed.
  29 .PP
  30 Should the exit status of the pager exceed 0 (for example,
  31 through the
  32 .B :cq
  33 command in
  34 .BR vifm ),
  35 .B aur\-view
  36 terminates immediately.
  37 .PP
  38 On a successful exit of the pager, the inspected
  39 .BR git (1)
  40 revisions are stored in
  41 .BR $XDG_DATA_HOME/aurutils/view ,
  42 or the path in the
  43 .B AUR_VIEW_DB
  44 environment variable, if set. These revisions are then used to
  45 generate diffs with
  46 .BR git\-diff (1)
  47 or
  48 .BR git\-log (1).
  49 Any changes to
  50 .B .SRCINFO
  51 and
  52 .B .gitignore
  53 files are ignored.
  54 .
  55 .SH OPTIONS
  56 .TP
  57 .BI \-\-format= TYPE
  58 If
  59 .I TYPE
  60 is
  61 .B diff
  62 or
  63 .BR log ,
  64 generate diffs with
  65 .BR git\-diff (1)
  66 or
  67 .BR git\-log (1),
  68 respectively. Defaults to
  69 .BR diff .
  70 .
  71 .TP
  72 .BI \-\-exclude= FILE
  73 Do not include
  74 .I FILE
  75 in the
  76 .BR git\-diff (1)
  77 or
  78 .BR git\-log (1)
  79 output. Can be specified multiple times.
  80 .
  81 .TP
  82 .B \-\-no\-patch
  83 Suppress patch output, only showing a summary.
  84 .
  85 .TP
  86 .BI \-\-revision= REV
  87 The revision used for comparing changes. Defaults to
  88 .IR HEAD .
  89 .
  90 .TP
  91 .BI \-\-prefix
  92 Prepend paths from command-line arguments or
  93 .B \-\-arg\-file
  94 to
  95 .BR git\-diff (1)
  96 and
  97 .BR git\-log (1)
  98 output, instead of
  99 .I a/
 100 and
 101 .IR b/ .
 102 .
 103 .TP
 104 .BI \-a " FILE" "\fR,\fP \-\-arg\-file=" FILE
 105 A textfile describing git repositories relative to the current
 106 directory. If unspecified, repositories are taken from the
 107 command-line.
 108 .
 109 .TP
 110 .B \-\-confirm
 111 Display a confirmation prompt after the file manager has exited
 112 successfully. See
 113 .B AUR_PAGER
 114 and
 115 .B AUR_CONFIRM_PAGER
 116 in the
 117 .B ENVIRONMENT
 118 section for details.
 119 .
 120 .SH ENVIRONMENT
 121 .TP
 122 .B AUR_VIEW_DB
 123 The directory where inspected
 124 .BR git (1)
 125 revisions are stored. Defaults to
 126 .BR $XDG_DATA_HOME/aurutils/view .
 127 .
 128 .TP
 129 .B AUR_PAGER
 130 The file manager used to view and edit build files. This variable is
 131 split on white space to allow program options, for example:
 132 .IR "AUR_PAGER=less \-K" .
 133 If unset,
 134 .B aur\-view
 135 defaults to
 136 .BR vifm (1).
 137 This two-pane file manager allows to quickly navigate between files in
 138 the left pane, and file previews in the right pane. Simultaneously,
 139 files can be edited with
 140 .BR vim (1).
 141 Other comparable file managers include
 142 .BR mc (1),
 143 .BR nnn (1),
 144 .BR ranger (1),
 145 and
 146 .BR xplr (1).
 147 .
 148 .TP
 149 .B AUR_CONFIRM_PAGER
 150 If set, display an additional confirmation prompt after the file
 151 manager (see
 152 .BR AUR_PAGER )
 153 has exited successfully. This may be used for (GUI) file
 154 managers not supporting an exit status greater zero to indicate
 155 unreviewed files.
 156 .
 157 .SH NOTES
 158 After browsing to a different directory in the file manager, the view on
 159 argument directories is replaced by a view on the original directory. To
 160 alleviate this issue (and support file managers taking only a single directory
 161 as argument),
 162 .B aur\-view
 163 keeps a list of symbolic links in a temporary directory, which point to
 164 argument repositories. This directory also includes any generated diffs.
 165 .PP
 166 If the history of a
 167 .BR git (1)
 168 repository was rewritten, stored
 169 .B aur\-view
 170 revisions are potentially invalidated. Specifically,
 171 .BR git\-cat\-file (1)
 172 aborts when given a non-existing object. The offending revision can be
 173 removed manually:
 174 .EX
 175
 176   $ rm -rf ~/.local/share/aurutils/view/<package>
 177
 178 .XE
 179 .
 180 .SH SEE ALSO
 181 .ad l
 182 .nh
 183 .BR aur (1),
 184 .BR aur\-sync (1),
 185 .BR vifm (1)
 186 .
 187 .SH AUTHORS
 188 .MT https://github.com/AladW
 189 Alad Wenter
 190 .ME
 191 .
 192 .\" vim: set textwidth=72: