summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Reisner <d@falconindy.com>2010-11-30 19:09:36 -0500
committerDave Reisner <d@falconindy.com>2010-11-30 19:40:47 -0500
commitf827493abf3d6615818baec9ac1496196629eec4 (patch)
treeed99f29ae75ea770eaaf1d0f5c3f7d40a392a545
parentb185b057674387ca58511d722af8d4cfe8acc6a8 (diff)
downloadexpac-f827493abf3d6615818baec9ac1496196629eec4.tar.xz
have a man page
-rw-r--r--Makefile10
-rw-r--r--README.pod127
2 files changed, 134 insertions, 3 deletions
diff --git a/Makefile b/Makefile
index dc99f05..4b57966 100644
--- a/Makefile
+++ b/Makefile
@@ -3,7 +3,7 @@ include config.mk
SRC = expac.c
OBJ = ${SRC:.c=.o}
-all: expac
+all: expac doc
35:
${MAKE} PMCHECK=-D_HAVE_ALPM_FIND_SATISFIER all
@@ -14,16 +14,20 @@ all: expac
expac: ${OBJ}
${CC} -o $@ ${OBJ} ${LDFLAGS}
+doc: expac.1
+expac.1: README.pod
+ pod2man --section=1 --center="expac manual" --name="EXPAC" --release="expac ${VERSION}" $< > $@
+
install: expac
install -D -m755 expac ${DESTDIR}${PREFIX}/bin/expac
dist: clean
mkdir expac-${VERSION}
- cp Makefile expac.c expac-${VERSION}
+ cp Makefile expac.1 expac.c expac-${VERSION}
sed "s/^VERSION = .*/VERSION = ${VERSION}/" config.mk > expac-${VERSION}/config.mk
tar cf - expac-${VERSION} | gzip -9 > expac-${VERSION}.tar.gz
rm -rf expac-${VERSION}
clean:
- $(RM) ${OBJ} expac
+ $(RM) ${OBJ} expac expac.1
diff --git a/README.pod b/README.pod
new file mode 100644
index 0000000..b2282e0
--- /dev/null
+++ b/README.pod
@@ -0,0 +1,127 @@
+=head1 NAME
+
+expac - package data extraction utility
+
+=head1 SYNOPSIS
+
+Usage: I<expac> [options] E<lt>formatE<gt> targets...
+
+=head1 DESCRIPTION
+
+expac is a data extraction tool for alpm databases. It features printf-like
+flexibility and aims to be used as a simple tool for other pacman based
+utilities which don't link against the library. It uses pacman.conf as a config
+file for locating and loading your local and sync databases.
+
+Targets are provided on the command line, and can be specified by simple name,
+or in repo/pkg format if the --sync option is used.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-S, --sync>
+
+Search the sync databases for provided targets.
+
+=item B<-Q, --query>
+
+Search the local database for provided targets. This is the default behavior.
+
+=item B<-s, --search>
+
+Search for packages matching the strings specified by targets. This is a
+boolean AND query and regex is allowed.
+
+=item B<-d, --delim> <string>
+
+Separate each package with the specified I<string>. The default value is a
+newline character.
+
+=item B<-l, --listdelim> <string>
+
+Separate each list item with the specified I<string>. Lists are any interpreted
+sequence specified with a capital letter. The default value is two spaces.
+
+=item B<-t, --timefmt> <format>
+
+Output time described by the specified I<format>. This string is passed directly
+to strftime(3). The default format is %c.
+
+=item B<-v, --verbose>
+
+Output more. `Package not found' errors will be shown, and empty field values
+will display as 'None'.
+
+=item B<-h, --help>
+
+Display the help message and quit.
+
+=back
+
+=head1 FORMATTING
+
+The format argument allows the following interpreted sequences:
+
+ %B backup files
+
+ %C conflicts with
+
+ %D depends on
+
+ %E depends on (no version strings)
+
+ %F files (only with -Q)
+
+ %G groups
+
+ %L licenses
+
+ %N required by
+
+ %O optional deps
+
+ %P provides
+
+ %R replaces
+
+ %S provides (no version strings)
+
+ %a architecture
+
+ %b build date
+
+ %d description
+
+ %f filename (only with -S)
+
+ %i has install scriptlet
+
+ %k download size
+
+ %l install date (only with -Q)
+
+ %m install size
+
+ %n package name
+
+ %o (reserved)
+
+ %p packager name
+
+ %r repo
+
+ %s md5sum
+
+ %u project URL
+
+ %v version
+
+ %% literal %
+
+Standard backslash escape sequences are supported. See printf(1).
+
+=head1 AUTHOR
+
+Dave Reisner E<lt>d@falconindy.comE<gt>
+