From 98dc5672bceafe3dd1b7b3a1309de8970d8b5385 Mon Sep 17 00:00:00 2001 From: TomSweeneyRedHat Date: Wed, 22 Mar 2017 14:40:31 -0400 Subject: [PATCH 1/2] First of several submits for buildah manpages --- docs/Makefile | 6 ++++++ docs/buildah-from.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/buildah-from.md diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..e8763882d --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,6 @@ +GOMD2MAN = go-md2man + +docs: $(patsubst %.md,%.1,$(wildcard *.md)) + +%.1: %.md + $(GOMD2MAN) -in $^ -out $@ diff --git a/docs/buildah-from.md b/docs/buildah-from.md new file mode 100644 index 000000000..3e1a8bb2a --- /dev/null +++ b/docs/buildah-from.md @@ -0,0 +1,40 @@ +## buildah-from "March 2017" + +## NAME +buildah from - Creates a new working container, either from scratch or based on the provided image name as a starting point. + + +## SYNOPSIS +**buildah** **from** --image *imagename* [*options* [...]] + +## DESCRIPTION +Creates a working container based upon the supplied image name. If the supplied image name is "scratch" a new default container will be created. + +## OPTIONS +**--name** *name* +Specifies a name to use for the newly created working container. + +**--pull** +Pull the image if it is not present. If this flag is not specified,the image will not be pulled regardless. + +**--pull-always** +Pull the image even if a version of the image is already present. + +**--registry** *registry* +A prefix to prepend to the image name in order to pull the image. Default value is "docker://" + +**--signature-policy** *signaturepolicy* +The path of the for the signature policy file. The default value is *PATH*. + +**--mount** +The working container will be mounted when specified. + +**--link** link +Path name of a symbolic link to create to the root directory of the container. + + +## EXAMPLE +**buildah from --image imagename --pull --registry "myregistry://" --mount ** + +## SEE ALSO +buildah-list(1) From a5e1ac3761455f4663ba9fa5f93e37d3e5f44f5e Mon Sep 17 00:00:00 2001 From: TomSweeneyRedHat Date: Wed, 22 Mar 2017 14:40:31 -0400 Subject: [PATCH 2/2] First of several submits for buildah manpages --- docs/buildah-from.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/buildah-from.md b/docs/buildah-from.md index 3e1a8bb2a..b65c5d2ef 100644 --- a/docs/buildah-from.md +++ b/docs/buildah-from.md @@ -1,7 +1,7 @@ ## buildah-from "March 2017" ## NAME -buildah from - Creates a new working container, either from scratch or based on the provided image name as a starting point. +buildah from - Creates a container image based on the supplied image name. If the supplied image name is "scratch" a new default empty container image will be created. ## SYNOPSIS @@ -11,11 +11,9 @@ buildah from - Creates a new working container, either from scratch or based on Creates a working container based upon the supplied image name. If the supplied image name is "scratch" a new default container will be created. ## OPTIONS -**--name** *name* -Specifies a name to use for the newly created working container. **--pull** -Pull the image if it is not present. If this flag is not specified,the image will not be pulled regardless. +Pull the image if it is not present. If this flag is not specified,the image will not be pulled regardless. Defaults to TRUE. **--pull-always** Pull the image even if a version of the image is already present. @@ -24,7 +22,7 @@ Pull the image even if a version of the image is already present. A prefix to prepend to the image name in order to pull the image. Default value is "docker://" **--signature-policy** *signaturepolicy* -The path of the for the signature policy file. The default value is *PATH*. +The path of the for the signature policy file. The default location is */etc/containers/policy.json* and changing to another file is not recommended. **--mount** The working container will be mounted when specified. @@ -35,6 +33,8 @@ Path name of a symbolic link to create to the root directory of the container. ## EXAMPLE **buildah from --image imagename --pull --registry "myregistry://" --mount ** +**buildah from --image imagename --mount --link ~/mycontainerroot --signature-policy /etc/containers/policy.json ** +**buildah from --image imagename --pull-always --registry "myregistry://" ** ## SEE ALSO buildah-list(1)