AUR-VIEW(1)

NAME
aur-view - inspect git repositories

SYNOPSIS
aur view [-a arg_file] [--format] repository...

DESCRIPTION
aur-view presents git(1) repositories stored in a common directory for inspection. Only repositories whose names match aur-view arguments are shown.

The used file manager or pager is determined in the following order:

•   The value of AUR_PAGER, if defined;

•   vifm(1), if installed.

Should the exit status of the pager exceed 0 (for example, through the :cq command in vifm), aur-view terminates immediately.

On a successful exit of the pager, the inspected git(1) revisions are stored in $XDG_DATA_HOME/aurutils/view, or the path in the AUR_VIEW_DB environment variable, if set. These revisions are then used to generate diffs with git-diff(1) or git-log(1). Any changes to .SRCINFO and .gitignore files are ignored.

OPTIONS

--format=TYPE
    If TYPE is diff or log, generate diffs with git-diff(1) or git-log(1), respectively. Defaults to diff.

--exclude=FILE
    Do not include FILE in the git-diff(1) or git-log(1) output. Can be specified multiple times.

--no-patch
    Suppress patch output, only showing a summary.

--revision=REV
    The revision used for comparing changes. Defaults to HEAD.

--prefix
    Prepend paths from command-line arguments or --arg-file to git-diff(1) and git-log(1) output, instead of a/ and b/.

-a FILE, --arg-file=FILE
    A textfile describing git repositories relative to the current directory. If unspecified, repositories are taken from the command-line.

--confirm
    Display a confirmation prompt after the file manager has exited successfully. See AUR_PAGER and AUR_CONFIRM_PAGER in the ENVIRONMENT section for details.

ENVIRONMENT

AUR_VIEW_DB
    The directory where inspected git(1) revisions are stored. Defaults to $XDG_DATA_HOME/aurutils/view.

AUR_PAGER
    The file manager used to view and edit build files. This variable is split on white space to allow program options, for example: AUR_PAGER=less -K. If unset, aur-view defaults to vifm(1). This two-pane file manager allows to quickly navigate between files in the left pane, and file previews in the right pane. Simultaneously, files can be edited with vim(1). Other comparable file managers include mc(1), nnn(1), ranger(1), and xplr(1).

AUR_CONFIRM_PAGER
    If set, display an additional confirmation prompt after the file manager (see AUR_PAGER) has exited successfully. This may be used for (GUI) file managers not supporting an exit status greater zero to indicate unreviewed files.

NOTES
After browsing to a different directory in the file manager, the view on argument directories is replaced by a view on the original directory. To alleviate this issue (and support file managers taking only a single directory as argument), aur-view keeps a list of symbolic links in a temporary directory, which point to argument repositories. This directory also includes any generated diffs.

If the history of a git(1) repository was rewritten, stored aur-view revisions are potentially invalidated. Specifically, git-cat-file(1) aborts when given a non-existing object. The offending revision can be removed manually:
      $ rm -rf ~/.local/share/aurutils/view/<package>

SEE ALSO
aur(1), aur-sync(1), vifm(1)

AUTHORS
Alad Wenter (https://github.com/AladW)