Permalink
Browse files

get manpage build stuff going

  • Loading branch information...
1 parent 8dc5de7 commit b5854bde9779c8d80ef88832799c91d8fde70e93 @rtomayko committed Mar 18, 2010
Showing with 97 additions and 2 deletions.
  1. +5 −2 Makefile
  2. +33 −0 doc/Makefile
  3. +59 −0 doc/rpg-solve.1.ronn
View
@@ -48,8 +48,7 @@ PROGRAMPROGRAMS = \
rpg-prepare rpg-complete rpg-help rpg-package-index
USERPROGRAMS = rpg rpg-sh-setup
-
-PROGRAMS = $(USERPROGRAMS) $(PROGRAMPROGRAMS)
+PROGRAMS = $(USERPROGRAMS) $(PROGRAMPROGRAMS)
.SUFFIXES: .sh .rb .html
@@ -88,6 +87,9 @@ build: $(PROGRAMS)
auto:
while true; do $(MAKE) ; sleep 1; done
+man:
+ $(MAKE) -C doc man
+
doc: $(DOCHTML)
install:
@@ -123,6 +125,7 @@ install-local:
clean:
rm -vf $(PROGRAMS) $(DOCHTML)
+ $(MAKE) -C doc clean
.SILENT:
View
@@ -0,0 +1,33 @@
+.POSIX:
+
+include ../config.mk
+
+MANPAGES = rpg-solve.1
+MANPAGESHTML = rpg-solve.1.html
+RONN = ronn --manual="RPG MANUAL" --organization="Ryan Tomayko"
+
+all:: man
+
+man: $(MANPAGES) $(MANPAGESHTML)
+
+.SUFFIXES: .ronn .html
+
+.ronn:
+ printf "%13s %-30s" "[ROFF]" "$@"
+ ronn $< > $@+
+ mv $@+ $@
+ printf " OK\n"
+
+.ronn.html:
+ printf "%13s %-30s" "[HTML]" "$@"
+ ronn -5 $< > $@+
+ mv $@+ $@
+ printf " OK\n"
+
+clean:
+ rm -vf $(MANPAGES)
+ rm -vf $(MANPAGESHTML)
+
+.SILENT:
+
+.PHONY: clean
View
@@ -0,0 +1,59 @@
+rpg-solve(1) -- rpg package dependency and version solver
+=========================================================
+
+## SYNOPSIS
+
+`rpg solve` [`-u`] [<INDEX>]...
+
+## DESCRIPTION
+
+Reads a _package list_ from standard input, resolves version expressions
+to concrete package versions against <index>, and writes a _package
+index_ of resolved packages to standard output. Packages that cannot be
+resolved to concrete versions have a '-' version field.
+
+## OPTIONS
+
+ * `-u`:
+ By default, all matching package versions listed in <index> are written
+ to standard output. This option causes only the best match for each package
+ to be written instead.
+
+## INPUT FORMAT
+
+`rpg-solve` expects a *package list* on standard input. A package list
+is a simple text file where each line specifies a package matching rule.
+It looks like this:
+
+ <source> <SP> <package> <SP> <verspec> <SP> <version> <NL>
+
+The `<package>` is the package name, `<version>` is the package version, and
+`<verspec>` is one of: `<`, `<=`, `=`, `>=`, or `>`. The `<source>` field
+specifies where the requirement originated. This can be a package name (in case
+of dependencies), `~user` (in case of user install), or `-` to denote the
+requirement has no source or the source is unimportant.
+
+An example package list:
+
+ ~user rails > 2.2
+ ~user sinatra >= 0
+ rails activesupport = 2.2
+ rails activerecord = 2.2
+ sinatra rack >= 1.0
+ rails rack >= 1.0.1
+
+## OUTPUT FORMAT
+
+`rpg-solve` writes a *package index* on standard output. A package
+index is a simple text file where each line specifies a concrete package
+name and version. It looks like this:
+
+ <package> <SP> <version> <NL>
+
+Package indexes are usually sorted, first by `<package>` and then in
+reverse by `<version>`. This allows efficient lookups for many packages
+in a single pass over a file.
+
+## SEE ALSO
+
+rpg-package-list(1), rpg-prepare(1), rpg-install(1)

0 comments on commit b5854bd

Please sign in to comment.