man1/aur-view.1

   1 .TH AUR-VIEW 1 2022-03-12 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 git repositories to the user for inspection. A file
  15 manager or pager is determined in the following order:
  16 .IP \(bu 4
  17 The value of
  18 .BR AUR_PAGER ", "
  19 if defined;
  20 .IP \(bu 4
  21 .BR vifm "(1), "
  22 if installed.
  23 .PP
  24 Should the exit status of the pager exceed 0 (for example,
  25 through the
  26 .B :cq
  27 command in
  28 .BR vifm ),
  29 .B aur\-view
  30 terminates immediately.
  31 .PP
  32 On a successful exit of the pager, the inspected
  33 .BR git (1)
  34 revisions are stored in
  35 .BR $XDG_DATA_HOME/aurutils/view ,
  36 or the path in the
  37 .B AUR_VIEW_DB
  38 environment variable, if set. These revisions are then used to
  39 generate diffs with
  40 .BR git\-diff (1)
  41 or
  42 .BR git\-log (1).
  43 .
  44 .SH OPTIONS
  45 .TP
  46 .B \-\-format
  47 Can be one of
  48 .B diff
  49 or
  50 .BR log ,
  51 to generate diffs with
  52 .BR git\-diff (1)
  53 and
  54 .BR git\-log (1),
  55 respectively.
  56 .
  57 .TP
  58 .B \-\-no\-patch
  59 Suppress patch output, only showing a summary.
  60 .
  61 .TP
  62 .BI \-\-revision= REV
  63 The revision used for comparing changes. Defaults to
  64 .IR HEAD .
  65 .
  66 .TP
  67 .BI \-a " FILE" "\fR,\fP \-\-arg\-file=" FILE
  68 A textfile describing git repositories relative to the current
  69 directory. If unspecified, repositories are taken from the
  70 command-line.
  71 .
  72 .SH ENVIRONMENT
  73 .TP
  74 .B AUR_VIEW_DB
  75 .
  76 .TP
  77 .B AUR_PAGER
  78 The file manager used to view and edit build files. This variable is
  79 split on white space to allow program options, for example:
  80 .IR "AUR_PAGER=less \-K" .
  81 .
  82 .TP
  83 .B AUR_CONFIRM_PAGER
  84 Display an additional prompt after the file manager has exited (see
  85 .BR AUR_PAGER ).
  86 If set, display an additional confirmation prompt after the file
  87 manager has exited successfully. This may be used for (GUI) file
  88 managers not supporting an exit status greater zero to indicate
  89 unreviewed files.
  90 .
  91 .SH SEE ALSO
  92 .ad l
  93 .nh
  94 .BR aur (1),
  95 .BR aur\-sync (1),
  96 .BR vifm (1)
  97 .
  98 .SH AUTHORS
  99 .MT https://github.com/AladW
 100 Alad Wenter
 101 .ME
 102 .
 103 .\" vim: set textwidth=72: