Commit Diff
Diff:
2ca2e1e39206ec748fcdeec2ccfb3fd58de5861d
58af4e09bd655c305c61ddcb290ce81d5dd967eb
Commit:
58af4e09bd655c305c61ddcb290ce81d5dd967eb
Tree:
c46dbf020851e0061d25d30605bfb71fcfd494bf
Author:
Omar Polo <op@xglobe.in>
Date:
Sat Feb 29 10:19:05 2020 UTC
Message:
added readme
commit - 2ca2e1e39206ec748fcdeec2ccfb3fd58de5861d
commit + 58af4e09bd655c305c61ddcb290ce81d5dd967eb
blob - /dev/null
blob + f964e39e30445821fbddd914c6189d8154f05076 (mode 644)
--- /dev/null
+++ README.md
@@ -0,0 +1,144 @@
+DEPCHECK(1) - General Commands Manual
+
+# NAME
+
+**depcheck** - look for outdated packages
+
+# SYNOPSIS
+
+**depcheck**
+\[**-s**]
+\[**-c**&nbsp;*cache*]
+\[**-d**&nbsp;*db*]
+action
+\[*args...*]
+
+# DESCRIPTION
+
+The
+**depcheck**
+utility tracks packages version from alpine linux repositories to
+check when an update is available.
+
+The arguments are as follows:
+
+**-s**
+
+> Doesn't print status information, be silent.
+
+**-c** *cache*
+
+> Set the cache file
+
+**-d** *db*
+
+> Set the db file
+
+The action are as follows:
+
+add *package* \[version]
+
+> Track
+> *package*
+> using the given version, or the one in the cache if not given.
+
+check
+
+> Alias for check-updates.
+
+check-updates
+
+> Confront the list of tracked packages against the cache and print the
+> packages that needs to be updated
+
+cron
+
+> Set verbose to off, updates the cache and then check for updates. It's
+> an an alias for
+
+> > depcheck -s update-cache
+> > depcheck check-updates
+
+help \[topic]
+
+> Print help information about
+> \[topic]
+> . Otherwise, print general information about the program.
+
+lookup *package*
+
+> Looks up package version in cache
+
+remove *package*
+
+> Don't track
+> *package*
+> anymore.
+
+update
+
+> Alias for update-cache.
+
+update-cache
+
+> Discard the current cache and downloads the latest list of packages.
+
+All commands that deals with cache will try to create one if not found.
+
+# ENVIRONMENT
+
+The following environment variables are respected
+
+`FTP`
+
+> A program (eventually with the proper flags) that downloads the given
+> page via HTTP and print it to standard output. By default uses
+> ftp(1) on OpenBSD, fetch(1) on FreeBSD and curl(1)
+> on other sistem if available.
+
+`URI`
+
+> The base address of an alpine linux mirror. By default is
+> http://dl-cdn.alpinelinux.org/alpine. Note that it does not ends with
+> a slash '/'.
+
+`BRANCH`
+
+> The branch of packages to consider, "edge" by default.
+
+`REPOS`
+
+> A space-delimited list of repository to cache. By default is "main
+> community".
+
+`ARCH`
+
+> The architecture to consider, x86\_64 by default.
+
+`DEPCHECKCACHE`
+
+> The path to the cache file. It is "cache" by default.
+
+`DEPCHECKDB`
+
+> The path to the database. It is "db" by default.
+
+# FILES
+
+cache
+
+> The cache file contains line in the form of package-version as found
+> on the mirror
+
+db
+
+> The database file contains a series of package:version lines.
+
+# EXAMPLES
+
+**depcheck**
+is crontab-friendly:
+
+ depcheck cron
+
+OpenBSD 6.6 - February 23, 2020
Omar Polo