Verified Commit cd8484e7 authored by Jelle van der Waa's avatar Jelle van der Waa 🚧
Browse files

Add a man page

Include a man page for arch-rebuild-order including a Makefile to build
and install the man page and binary.

Closes: #4
parent a23d5275
Pipeline #4437 passed with stages
in 3 minutes and 29 seconds
......@@ -10,3 +10,6 @@
# Backup files generated by rustfmt
**/*.rs.bk
# man pages
doc/*.1
PREFIX ?= /usr/local
BINDIR ?= $(PREFIX)/bin
MANDIR ?= $(PREFIX)/share/man
# Tools
CARGO ?= cargo
MANDOWN ?= mandown
BIN=arch-rebuild-order
MANPAGE=arch-rebuild-order.1
DOCDIR=doc
all: build doc
doc: $(DOCDIR)/$(MANPAGE)
%.1: %.md
$(MANDOWN) $< > $@
build:
$(CARGO) build --release --locked
.PHONY: install
install: doc
install -Dm755 target/release/$(BIN) $(DESTDIR)$(BINDIR)/$(BIN)
install -Dm644 $(DOCDIR)/$(MANPAGE) $(DESTDIR)$(MANDIR)/man1/$(MANPAGE)
# NAME
arch-rebuild-order - Rebuild order generation script
# SYNOPSIS
**arch-rebuild-order** [OPTION]... [PACKAGES]...
# DESCRIPTION
Generate a rebuild order for given packages using pacman's local syncdb's.
**--d=FILE, --dotfile=FILE** Generate a .dot graph file with the rebuild order of the gives packages
**--dbpath=PATH** the path to pacman's database path
**--repos=REPOS** the repositories to retrieve the package information from
**-V, --version** prints version information
**-h, --help** prints help information
# EXAMPLES
Generating an image of the rebuild order of provided package(s):
$ **arch-rebuild-order** -d linux-rebuild-order.dot linux
$ dot -Tpng linux-rebuild-order.dot > linux-rebuild-order.pn
# BUGS
[Bug tracker](https://gitlab.archlinux.org/archlinux/arch-rebuild-order/-/issues)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment