Merge pull request containers#1297 from rhatdan/man

Add man page for krun

Makefile.am

@@ -149,6 +149,7 @@ EXTRA_DIST = COPYING COPYING.libcrun README.md NEWS SECURITY.md rpm/crun.spec au
 	src/libcrun/linux.h src/libcrun/utils.h src/libcrun/error.h src/libcrun/criu.h \
 	src/libcrun/scheduler.h src/libcrun/status.h src/libcrun/terminal.h src/libcrun/mount_flags.h \
 	crun.1.md crun.1 libcrun.lds \
+	krun.1.md krun.1 \
 	lua/luacrun.rockspec
 
 UNIT_TESTS = tests/tests_libcrun_utils tests/tests_libcrun_errors
@@ -240,15 +241,20 @@ BUILT_SOURCES = .version git-version.h
 CLEANFILES = crun.spec .version git-version.h $(LUACRUN_ROCKSPEC)
 
 if ENABLE_CRUN
-man1_MANS = crun.1
+man1_MANS = crun.1 krun.1
 endif
 
 crun.1: $(abs_srcdir)/crun.1.md
 if HAVE_MD2MAN
 	$(MD2MAN) -in $(abs_srcdir)/crun.1.md -out crun.1
 endif HAVE_MD2MAN
 
-generate-man: crun.1
+krun.1: $(abs_srcdir)/krun.1.md
+if HAVE_MD2MAN
+	$(MD2MAN) -in $(abs_srcdir)/krun.1.md -out krun.1
+endif HAVE_MD2MAN
+
+generate-man: crun.1 krun.1
 
 sync:
 	(cd libocispec; git pull https://github.com/containers/libocispec main)

krun.1

@@ -0,0 +1,43 @@
+.nh
+.TH crun 1 "User Commands"
+
+.SH NAME
+.PP
+krun - crun based OCI runtime using libkrun to run containerized programs in
+isolated KVM environments
+
+
+.SH SYNOPSIS
+.PP
+krun [global options] command [command options] [arguments...]
+
+
+.SH DESCRIPTION
+.PP
+krun is a sub package of the crun command line program for running Linux
+containers that follow the Open Container Initiative (OCI) format. The krun
+command is a symbolic link to the crun executable, that tells crun to run in
+krun mode.
+
+.PP
+krun uses the dynamic libkrun library to run processes in an isolated
+environment using KVM Virtualization.
+
+.PP
+libkrun integrates a VMM (Virtual Machine Monitor, the userspace side of a
+Hypervisor) with the minimum amount of emulated devices required for its
+purpose, abstracting most of the complexity from Virtual Machine management.
+
+.PP
+Because of the additional isolation, sharing content with processes and other
+containers outside of the krun VM is more difficult.
+
+
+.SH COMMANDS
+.PP
+See crun.1 man page for the commands available to krun
+
+
+.SH SEE ALSO
+.PP
+crun.1

krun.1.md

@@ -0,0 +1,34 @@
+crun 1 "User Commands"
+==================================================
+
+# NAME
+
+krun - crun based OCI runtime using libkrun to run containerized programs in
+isolated KVM environments
+
+# SYNOPSIS
+
+krun [global options] command [command options] [arguments...]
+
+# DESCRIPTION
+
+krun is a sub package of the crun command line program for running Linux
+containers that follow the Open Container Initiative (OCI) format. The krun
+command is a symbolic link to the crun executable, that tells crun to run in
+krun mode.
+
+krun uses the dynamic libkrun library to run processes in an isolated
+environment using KVM Virtualization.
+
+libkrun integrates a VMM (Virtual Machine Monitor, the userspace side of a
+Hypervisor) with the minimum amount of emulated devices required for its
+purpose, abstracting most of the complexity from Virtual Machine management.
+
+Because of the additional isolation, sharing content with processes and other
+containers outside of the krun VM is more difficult.
+# COMMANDS
+
+See crun.1 man page for the commands available to krun
+
+# SEE ALSO
+crun.1

rpm/crun.spec

@@ -126,12 +126,13 @@ ln -s %{_bindir}/%{name} %{buildroot}%{_bindir}/%{name}-wasm
 %files
 %license COPYING
 %{_bindir}/%{name}
-%{_mandir}/man1/*
+%{_mandir}/man1/crun.1
 
 %if %{defined krun_support}
 %files krun
 %license COPYING
 %{_bindir}/krun
+%{_mandir}/man1/krun.1
 %endif
 
 %if %{defined wasm_support}