[DRE-commits] [itamae] 06/08: Add manpage for itamae command.

Scott Leggett smlx-guest at moszumanska.debian.org
Thu Dec 1 10:34:55 UTC 2016 

This is an automated email from the git hooks/post-receive script.

smlx-guest pushed a commit to branch master
in repository itamae.

commit c0158c8bc0f896b34ba661c7af628d5c23e6c069
Author: Scott Leggett <scott at sl.id.au>
Date:   Thu Dec 1 00:08:26 2016 +1100

    Add manpage for itamae command.
---
 debian/control         |   3 +-
 debian/dh_ruby.rake    |  16 ++++
 debian/itamae.1.adoc   | 224 +++++++++++++++++++++++++++++++++++++++++++++++++
 debian/itamae.manpages |   1 +
 4 files changed, 243 insertions(+), 1 deletion(-)

diff --git a/debian/control b/debian/control
index 0f9acd1..c45633f 100644
--- a/debian/control
+++ b/debian/control
@@ -3,7 +3,8 @@ Section: ruby
 Priority: optional
 Maintainer: Debian Ruby Extras Maintainers <pkg-ruby-extras-maintainers at lists.alioth.debian.org>
 Uploaders: Scott Leggett <scott at sl.id.au>
-Build-Depends: debhelper (>= 9~),
+Build-Depends: asciidoctor,
+               debhelper (>= 9~),
                gem2deb,
                rake,
                ruby-ansi,
diff --git a/debian/dh_ruby.rake b/debian/dh_ruby.rake
new file mode 100644
index 0000000..d925de8
--- /dev/null
+++ b/debian/dh_ruby.rake
@@ -0,0 +1,16 @@
+require 'asciidoctor'
+
+MANPAGE_PATH = 'debian/itamae.1'
+ADOC_PATH = MANPAGE_PATH + '.adoc'
+
+task :default do
+  Asciidoctor.render_file(
+    ADOC_PATH, backend: 'manpage', doctype: 'manpage', in_place: true
+  )
+end
+task :install do
+  # dh_installman does the work here
+end
+task :clean do
+  File.unlink(MANPAGE_PATH) if File.exist?(MANPAGE_PATH)
+end
diff --git a/debian/itamae.1.adoc b/debian/itamae.1.adoc
new file mode 100644
index 0000000..0f8f89b
--- /dev/null
+++ b/debian/itamae.1.adoc
@@ -0,0 +1,224 @@
+= itamae(1)
+Ryota Arai
+:doctype: manpage
+:man manual: Itamae Manual
+:man source: Itamae 1.9.9
+
+== NAME
+
+itamae - Simple and lightweight configuration management tool inspired by Chef.
+
+== SYNOPSIS
+
+*itamae destroy* [cookbook|role] [_NAME_]
+
+*itamae docker* _RECIPE_ [_RECIPE_...]
+
+*itamae generate* [cookbook|role] [_NAME_]
+
+*itamae help* [_COMMAND_]
+
+*itamae init* _NAME_
+
+*itamae local* _RECIPE_ [_RECIPE_...]
+
+*itamae ssh* _RECIPE_ [_RECIPE_...]
+
+*itamae version*
+
+== DESCRIPTION
+
+itamae(1) is a simple and lightweight configuration management tool inspired by Chef.
+
+== SUBCOMMANDS
+
+=== destroy
+
+Undo role or cookbook (short-cut alias *d*).
+
+=== docker
+
+Create Docker image.
+
+=== generate
+
+Initialize role or cookbook (short-cut alias: _g_).
+
+=== help
+
+Describe available commands or one specific command.
+
+=== init
+
+Create a new project.
+
+=== local
+
+Run Itamae locally.
+
+=== ssh
+
+Run Itamae via ssh.
+
+== OPTIONS
+
+Options are valid for all subcommands unless otherwise noted.
+
+*-l, --log-level*=_LOG_LEVEL_::
+  Set the level of logging detail.
+  Possible values, in increasingly verbose order, _unknown_, _fatal_, _error_, _warn_, _info_ (the default), _debug_.
+
+*--[no-]color*::
+  Enable (the default) or disable color logging to STDOUT.
+
+*-c, --config*=_CONFIG_::
+  Load configuration from a file in YAML format in addition to command line options (no default).
+
+*--recipe-graph*=_PATH_::
+  [EXPERIMENTAL] Write recipe dependency graph in DOT.
++
+Subcommands: *docker*, *local*, *ssh*.
+
+*-j, --node-json*=_NODE_JSON_::
+  Load node data from a JSON formatted file, _NODE_JSON_.
++
+Subcommands: *docker*, *local*, *ssh*.
+
+*-y, --node-yaml*=_NODE_YAML_::
+  Load node data from a YAML formatted file, _NODE_YAML_.
++
+Subcommands: *docker*, *local*, *ssh*.
+
+*-n, --[no-]dry-run*::
+  Only show the steps that would be taken.
++
+Subcommands: *docker*, *local*, *ssh*.
+
+*--shell*=_SHELL_::
+  Set the shell in the image. Default _/bin/sh_.
++
+Subcommands: *docker*, *local*, *ssh*.
+
+*--[no-]login-shell*::
+  Enable or disable a login shell. Default disabled.
++
+Subcommands: *docker*, *local*, *ssh*.
+
+*--[no-]ohai*::
+  This option is DEPRECATED and will be unavailable.
++
+Subcommands: *docker*, *local*, *ssh*.
+
+*--profile*=_PATH_::
+  [EXPERIMENTAL] Save profiling data to _PATH_.
++
+Subcommands: *docker*, *local*, *ssh*.
+
+*--[no-]detailed-exitcode*::
+  Enable detailed exit codes (default disabled). See *EXIT STATUS*.
++
+Subcommands: *docker*, *local*, *ssh*.
+
+*--image*=_IMAGE_::
+  Output image. This option or 'container' option is required.
++
+Subcommands: *docker*.
+
+*--container*=_CONTAINER_::
+  Output container. This option or 'image' option is required.
++
+Subcommands: *docker*.
+
+*--[no-]tls-verify-peer]*::
+  Verify TLS certificates. Default enabled.
++
+Subcommands: *docker*.
+
+*-h, --host*=_HOST_::
+  Connect to the given _HOST_. This option or *--vagrant* must be specified.
++
+Subcommands: *ssh*.
+
+*-u, --user*=_USER_::
+  Connect using the given _USER_.
++
+Subcommands: *ssh*.
+
+*-i, --key*=_KEY_::
+  Connect using the given _KEY_.
++
+Subcommands: *ssh*.
+
+*-p, --port*=_PORT_::
+  Connect to the given _PORT_.
++
+Subcommands: *ssh*.
+
+*--ssh-config*=_SSH_CONFIG_::
+  Use the given _SSH_CONFIG_.
++
+Subcommands: *ssh*.
+
+*--[no-]vagrant*::
+  Use Vagrant. Default disabled. This option or *--host* must be specified.
++
+Subcommands: *ssh*.
+
+*--[no-]ask-password*::
+  Prompt for a password. Default disabled.
++
+Subcommands: *ssh*.
+
+*--[no-]sudo*::
+  Use sudo to run commands on the _HOST_. Default enabled.
++
+Subcommands: *ssh*.
+
+== ENVIRONMENT
+
+*SUDO_PASSWORD*::
+  Used to elevate privileges if required. If not set, and elevated privileges are required, the user will be prompted.
+
+== EXIT STATUS
+
+With *--detailed-exitcode=false* (default):
+
+*0*::
+  The run succeeded with no failures, some changes may have occurred.
+
+*1*::
+  The run failed (syntax or usage error; configuration error; unexpected error).
+
+With *--detailed-exitcode=true*:
+
+*0*::
+  The run succeeded with no changes or failures.
+
+*1*::
+  The run failed (syntax or usage error; configuration error; unexpected error).
+
+*2*::
+  The run succeeded, and some resources were changed.
+
+== BUGS
+
+Refer to the *Itamae* issue tracker at https://github.com/itamae-kitchen/itamae/issues
+
+== AUTHORS
+
+*Itamae* was written by Ryota Arai, and other contributors.
+
+This man page was written by Scott Leggett for the Debian Project.
+
+== RESOURCES
+
+*Project web site:* http://itamae.kitchen/
+
+*Git source repository on GitHub:* https://github.com/itamae-kitchen/itamae
+
+*GitHub organization:* https://github.com/itamae-kitchen
+
+== COPYING
+
+Copyright \(C) 2013-2016 {author}.
+Free use of this software is granted under the terms of the MIT License.
diff --git a/debian/itamae.manpages b/debian/itamae.manpages
new file mode 100644
index 0000000..d4cd4ea
--- /dev/null
+++ b/debian/itamae.manpages
@@ -0,0 +1 @@
+debian/itamae.1

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/itamae.git

More information about the Pkg-ruby-extras-commits mailing list