doc: add a manpage for scmp_sys_resolver

Signed-off-by: Paul Moore <pmoore@redhat.com>

3 files changed, 78 insertions, 2 deletions

diff --git a/doc/Makefile b/doc/Makefile
index 66810bf..2cef056 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -33,6 +33,9 @@ include $(TOPDIR)/version_info.mk
 include $(TOPDIR)/configure.mk
 include $(TOPDIR)/install.mk
 
+MAN1 = \
+	man/man1/scmp_sys_resolver.1
+
 MAN3 = \
 	man/man3/seccomp_init.3 \
 	man/man3/seccomp_load.3 \
@@ -58,11 +61,14 @@ MAN3 = \
 # targets
 #
 
-.PHONY: all install install_man3
+.PHONY: all install install_man1 install_man3
 
 all:
 
-install: install_man3
+install: install_man1 install_man3
+
+install_man1: $(MAN1)
+	$(INSTALL_MAN1_MACRO)
 
 install_man3: $(MAN3)
 	$(INSTALL_MAN3_MACRO)
diff --git a/doc/man/man1/scmp_sys_resolver.1 b/doc/man/man1/scmp_sys_resolver.1
new file mode 100644
index 0000000..fc28eaa
--- /dev/null
+++ b/doc/man/man1/scmp_sys_resolver.1
@@ -0,0 +1,60 @@
+.TH "scmp_sys_resolver" 1 "23 May 2013" "paul@paul-moore.com" "libseccomp Documentation"
+.\" //////////////////////////////////////////////////////////////////////////
+.SH NAME
+.\" //////////////////////////////////////////////////////////////////////////
+scmp_sys_resolver \- Resolve system calls
+.\" //////////////////////////////////////////////////////////////////////////
+.SH SYNOPSIS
+.\" //////////////////////////////////////////////////////////////////////////
+.B scmp_sys_resolver
+[\-h] [\-a
+.I ARCH
+] [\-t]
+.I SYSCALL_NAME
+|
+.I SYSCALL_NUMBER
+.\" //////////////////////////////////////////////////////////////////////////
+.SH DESCRIPTION
+.\" //////////////////////////////////////////////////////////////////////////
+.P
+This command resolves both system call names and numbers with respect to the
+given architecture supplied in the optional
+.I ARCH
+argument.  If the architecture is not supplied on the command line then the
+native architecture is used.  If the "\-t" argument is specified along with a
+system call name, then the system call will be translated as necessary for the
+given architecture.  The "\-t" argument has no effect if a system call number
+is specified.
+.P
+In some combinations of architecture and system call, a negative system call
+number will be displayed.  A negative system call number indicates that the
+system call is not defined for the given architecture and is treated in a
+special manner by libseccomp depending on the operation.
+.TP
+.B \-a \fIARCH
+The architecture to use for resolving the system call.  Valid
+.I ARCH
+values are "x86", "x86_64", "x32", and "arm".
+.TP
+.B \-t
+If neccessary, translate the system call name to the proper system call number,
+even if the system call name is different, e.g. socket(2) on x86.
+.TP
+.B \-h
+A simple one-line usage display.
+.\" //////////////////////////////////////////////////////////////////////////
+.SH EXIT STATUS
+.\" //////////////////////////////////////////////////////////////////////////
+Returns zero on success, errno values on failure.
+.\" //////////////////////////////////////////////////////////////////////////
+.SH NOTES
+.\" //////////////////////////////////////////////////////////////////////////
+.P
+The libseccomp project site, with more information and the source code
+repository, can be found at http://libseccomp.sf.net.  This tool, as well as
+the libseccomp library, is currently under development, please report any bugs
+at the project site or directly to the author.
+.\" //////////////////////////////////////////////////////////////////////////
+.SH AUTHOR
+.\" //////////////////////////////////////////////////////////////////////////
+Paul Moore <paul@paul-moore.com>
diff --git a/macros.mk b/macros.mk
index 04789a0..9c62fa7 100644
--- a/macros.mk
+++ b/macros.mk
@@ -205,6 +205,16 @@ INSTALL_INC_MACRO += \
 			$^ "$(INSTALL_INC_DIR)";
 
 ifeq ($(V),0)
+	INSTALL_MAN1_MACRO = \
+		@echo " INSTALL manpages ($(INSTALL_MAN_DIR)/man1)";
+endif
+INSTALL_MAN1_MACRO += \
+		$(INSTALL) -o $(INSTALL_OWNER) -g $(INSTALL_GROUP) \
+			-d "$(INSTALL_MAN_DIR)/man1"; \
+		$(INSTALL) -o $(INSTALL_OWNER) -g $(INSTALL_GROUP) -m 0644 \
+			$^ "$(INSTALL_MAN_DIR)/man1";
+
+ifeq ($(V),0)
 	INSTALL_MAN3_MACRO = \
 		@echo " INSTALL manpages ($(INSTALL_MAN_DIR)/man3)";
 endif