Skip to content

Commit

Permalink
Add man page
Browse files Browse the repository at this point in the history
Signed-off-by: Mrunal Patel <[email protected]>
  • Loading branch information
mrunalp committed Nov 23, 2015
1 parent bee8585 commit b6309d6
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
26 changes: 26 additions & 0 deletions doc/oci_systemd_hook.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "OCI_SYSTEMD_HOOK" "1" "November 2015" "" ""
.
.SH "NAME"
\fBoci_systemd_hook\fR \- OCI systemd hook
.
.SH "SYNOPSIS"
\fBoci_systemd_hook\fR [prestart|poststop]
.
.SH "DESCRIPTION"
Setup environment for systemd to run in docker or a OCI compatible runtime\. It is expected to receive the state of the container including the pid and ID over stdin as defined in the OCI specification (https://github\.com/opencontainers/specs)\. It mounts tmpfs at /run and /tmp, links journal directory to the host using a bind mount and creates /etc/machine\-id for the container systemd\.
.
.SH "ARGUMENTS"
.
.IP "\(bu" 4
prestart Setup the systemd environment in a container
.
.IP "\(bu" 4
poststop Teardown and undo the changes on the host done during prestart
.
.IP "" 0
.
.SH "AUTHORS"
Mrunal Patel \fImrunalp@gmail\.com\fR Dan Walsh \fIdwalsh@redhat\.com\fR
23 changes: 23 additions & 0 deletions doc/oci_systemd_hook.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
oci_systemd_hook(1) -- OCI systemd hook
=============================================

## SYNOPSIS

`oci_systemd_hook` [prestart|poststop]

## DESCRIPTION

Setup environment for systemd to run in docker or a OCI compatible runtime.
It is expected to receive the state of the container including the pid and ID over stdin
as defined in the OCI specification (https://github.com/opencontainers/specs).
It mounts tmpfs at /run and /tmp, links journal directory to the host using a bind mount
and creates /etc/machine-id for the container systemd.

## ARGUMENTS

* prestart Setup the systemd environment in a container
* poststop Teardown and undo the changes on the host done during prestart

## AUTHORS
Mrunal Patel <[email protected]>
Dan Walsh <[email protected]>

0 comments on commit b6309d6

Please sign in to comment.