summarylogtreecommitdiffstats
path: root/faur.1
diff options
context:
space:
mode:
Diffstat (limited to 'faur.1')
-rw-r--r--faur.134
1 files changed, 34 insertions, 0 deletions
diff --git a/faur.1 b/faur.1
new file mode 100644
index 000000000000..449d069f1ba8
--- /dev/null
+++ b/faur.1
@@ -0,0 +1,34 @@
+.\" Automatically generated by Pandoc 2.2.2
+.\"
+.TH "FAUR" "1" "July 17, 2018" "\- faur\-0.1" ""
+.hy
+.SH NAME
+.PP
+faur \- lightweight, opinionated AUR helper
+.SH SYNOPSIS
+.PP
+faur fetch [\f[I]pkgs\f[]]\&...
+.PP
+faur update
+.PP
+faur help
+.SH DESCRIPTION
+.PP
+faur downloads packages to the directory specified in $AURDIR.
+If $AURDIR is unset $HOME/aur is used as a default.
+Packages are cloned from the git repository located under $AUR_PATH, if
+unset https://aur.archlinux.org/ is used as a default value.
+.PP
+The update command checks to see which if any of the packages underneath
+$AURDIR need to be updated and notifies the user.
+.SH DEPENDENCY MANAGEMENT
+.PP
+faur \f[I]does not\f[] attempt to resolve dependencies, as doing so
+would discourage the user from reading PKGBUILD files before
+installation.
+.PP
+Users should bear in mind that the AUR is an \f[I]untrusted\f[] source
+of packages and always exercise caution when installing packages from
+it.
+.SH AUTHORS
+Joe Davis <me@jo.ie>.