added man pages and updated SPEC file

This commit is contained in:
Udo Seidel 2014-03-25 08:36:20 +01:00
parent a95589a816
commit fd11e9f5d6
6 changed files with 111 additions and 2 deletions

View File

@ -1,6 +1,6 @@
include Makefile.inc
SUBDIRS = kpatch-build kpatch kmod
SUBDIRS = kpatch-build kpatch kmod man
BUILD_DIRS = $(SUBDIRS:%=build-%)
INSTALL_DIRS = $(SUBDIRS:%=install-%)
UNINSTALL_DIRS = $(SUBDIRS:%=uninstall-%)

View File

@ -9,6 +9,7 @@ SBINDIR = $(DESTDIR)$(PREFIX)/sbin
MODULESDIR = $(DESTDIR)$(PREFIX)/lib/modules
LIBEXECDIR = $(DESTDIR)$(PREFIX)/libexec/kpatch
DATADIR = $(DESTDIR)$(PREFIX)/share/kpatch
MANDIR = $(DESTDIR)$(PREFIX)/share/man/man1
.PHONY: all install clean
.DEFAULT: all

View File

@ -4,7 +4,7 @@ Version: 0.0.1
License: GPLv2
Group: System Environment/Kernel
URL: http://github.com/dynup/kpatch
Release: 1%{?dist}
Release: 2%{?dist}
Source0: %{name}-%{version}.tar.gz
Requires: kmod bash
@ -79,6 +79,7 @@ rm -rf %{buildroot}
%defattr(-,root,root,-)
%doc COPYING README.md
%{_sbindir}/kpatch
%{_mandir}/man1/kpatch.1*
%files %{KVER}
%defattr(-,root,root,-)
@ -89,7 +90,11 @@ rm -rf %{buildroot}
%{_bindir}/*
%{_libexecdir}/*
%{_datadir}/%{name}
%{_mandir}/man1/kpatch-build.1*
%changelog
* Tue Mar 25 2014 Udo Seidel <udoseidel@gmx.de> - 0.0.1-2
- added man pages
* Sat Mar 22 2014 Udo Seidel <udoseidel@gmx.de> - 0.0.1-1
- initial release

16
man/Makefile Normal file
View File

@ -0,0 +1,16 @@
include ../Makefile.inc
all:
install: all
$(INSTALL) -d $(MANDIR)
gzip -9 kpatch.1
$(INSTALL) -m 644 kpatch.1.gz $(MANDIR)
gzip -9 kpatch-build.1
$(INSTALL) -m 644 kpatch-build.1.gz $(MANDIR)
uninstall:
$(RM) $(MANDIR)/kpatch.1*
$(RM) $(MANDIR)/kpatch-build.1*
clean:

37
man/kpatch-build.1 Normal file
View File

@ -0,0 +1,37 @@
.\" Manpage for kpatch-build.
.\" Contact udoseidel@gmx.de to correct errors or typos.
.TH man 1 "23 Mar 2014" "1.0" "kpatch-build man page"
.SH NAME
kpatch-build \- build script
.SH SYNOPSIS
kpatch-build [options] <patch file>
.SH DESCRIPTION
This script takes a patch based on the version of the kernel
currently running and creates a kernel module that will replace
modified functions in the kernel such that the patched code takes
effect.
This script currently only works on Fedora and will need to be adapted
to work on other distros.
.SH OPTIONS
-h|--help
Show this help message
-s|--sourcedir
Specify kernel source directory
-c|--config
Specify kernel config file
.SH SEE ALSO
kpatch(1)
.SH BUGS
No known bugs.
.SH AUTHOR
Udo Seidel (udoseidel@gmx.de)
.SH COPYWRIGHT
Copyright (C) 2014: Seth Jennings <sjenning@redhat.com>, Copyright (C)
2013,2014: Josh Poimboeuf <jpoimboe@redhat.com>

50
man/kpatch.1 Normal file
View File

@ -0,0 +1,50 @@
.\" Manpage for kpatch.
.\" Contact udoseidel@gmx.de to correct errors or typos.
.TH man 1 "23 Mar 2014" "1.0" "kpatch man page"
.SH NAME
kpatch \- hot patch module management
.SH SYNOPSIS
kpatch <command> [<args>]
.SH DESCRIPTION
kpatch is a user script that manages installing, applying, and
displaying information about kernel patch modules installed on
the system.
.SH OPTIONS
install <file>
install hotpatch module to the kpatch DB
uninstall <hotpatch>
uninstall hotpatch module from the kpatch DB
apply --all
apply all enabled hotpatch modules to the running kernel
apply <hotpatch>
apply installed hotpatch module to the running kernel
remove <hotpatch>
remove hotpatch module from the running kernel
enable <hotpatch>
automatically apply hotpatch module during boot
disable <hotpatch>
don't automatically apply hotpatch module during boot
info <hotpatch>
show information about an installed hotpatch module
list
list installed hotpatch modules
.SH SEE ALSO
kpatch-build(1)
.SH BUGS
No known bugs.
.SH AUTHOR
Udo Seidel (udoseidel@gmx.de)
.SH COPYWRIGHT
Copyright (C) 2014: Seth Jennings <sjenning@redhat.com> and
Josh Poimboeuf <jpoimboe@redhat.com>