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). Any changes to
  49 .B .SRCINFO
  50 and
  51 .B .gitignore
  52 files are ignored.
  53 .
  54 .SH OPTIONS
  55 .TP
  56 .B \-\-format
  57 Can be one of
  58 .B diff
  59 or
  60 .BR log ,
  61 to generate diffs with
  62 .BR git\-diff (1)
  63 and
  64 .BR git\-log (1),
  65 respectively.
  66 .
  67 .TP
  68 .B \-\-no\-patch
  69 Suppress patch output, only showing a summary.
  70 .
  71 .TP
  72 .BI \-\-revision= REV
  73 The revision used for comparing changes. Defaults to
  74 .IR HEAD .
  75 .
  76 .TP
  77 .BI \-\-prefix
  78 Prepend paths from command-line arguments or
  79 .B \-\-arg\-file
  80 to
  81 .BR git\-diff (1)
  82 and
  83 .BR git\-log (1)
  84 output.
  85 .
  86 .TP
  87 .BI \-a " FILE" "\fR,\fP \-\-arg\-file=" FILE
  88 A textfile describing git repositories relative to the current
  89 directory. If unspecified, repositories are taken from the
  90 command-line.
  91 .
  92 .SH ENVIRONMENT
  93 .TP
  94 .B AUR_VIEW_DB
  95 The directory where inspected
  96 .BR git (1)
  97 revisions are stored. Defaults to
  98 .BR $XDG_DATA_HOME/aurutils/view .
  99 .
 100 .TP
 101 .B AUR_PAGER
 102 The file manager used to view and edit build files. This variable is
 103 split on white space to allow program options, for example:
 104 .IR "AUR_PAGER=less \-K" .
 105 If unset,
 106 .B aur\-view
 107 defaults to
 108 .BR vifm (1).
 109 This two-pane file manager allows to quickly navigate between files in
 110 the left pane, and file previews in the right pane. Simultaneously,
 111 files can be edited with
 112 .BR vim (1).
 113 Other comparable file managers include
 114 .BR mc (1),
 115 .BR nnn (1),
 116 .BR ranger (1),
 117 and
 118 .BR xplr (1).
 119 .
 120 .TP
 121 .B AUR_CONFIRM_PAGER
 122 Display an additional prompt after the file manager has exited (see
 123 .BR AUR_PAGER ).
 124 If set, display an additional confirmation prompt after the file
 125 manager has exited successfully. This may be used for (GUI) file
 126 managers not supporting an exit status greater zero to indicate
 127 unreviewed files.
 128 .
 129 .SH NOTES
 130 After browsing to a different directory in the file manager, the view on
 131 argument directories is replaced by a view on the original directory. To
 132 alleviate this issue (and support file managers taking only a single directory
 133 as argument),
 134 .B aur\-view
 135 keeps a list of symbolic links in a temporary directory, which point to
 136 argument repositories. This directory also includes any generated diffs.
 137 .PP
 138 If the history of a
 139 .BR git (1)
 140 repository was rewritten, stored
 141 .B aur\-view
 142 revisions are potentially invalidated. Specifically,
 143 .BR git\-cat\-file (1)
 144 aborts when given a non-existing object. The offending revision can be
 145 removed manually:
 146 .EX
 147
 148   $ rm -rf ~/.local/share/aurutils/view/<package>
 149
 150 .XE
 151 .
 152 .SH SEE ALSO
 153 .ad l
 154 .nh
 155 .BR aur (1),
 156 .BR aur\-sync (1),
 157 .BR vifm (1)
 158 .
 159 .SH AUTHORS
 160 .MT https://github.com/AladW
 161 Alad Wenter
 162 .ME
 163 .
 164 .\" vim: set textwidth=72: