Better sphinx manpage ext. Add custom dotman Makefile target for custom .cdist directory.
This commit is contained in:
Darko Poljak
parent
e819dd0470
commit
b89077f9a5
114 changed files with 549 additions and 122 deletions
23
Makefile
23
Makefile
|
|
@ -88,6 +88,29 @@ man-latest-link: web-pub
|
|||
ssh staticweb.ungleich.ch \
|
||||
"cd /home/services/www/nico/nico.schottelius.org/www/software/cdist/man/ && rm -f latest && ln -sf "$(CHANGELOG_VERSION)" latest"
|
||||
|
||||
# Manpages: .cdist Types
|
||||
DOT_CDIST_PATH=${HOME}/.cdist
|
||||
DOTMAN7DSTDIR=$(MAN7DSTDIR)
|
||||
DOTTYPEDIR=$(DOT_CDIST_PATH)/type
|
||||
$(info $(DOTTYPEDIR))
|
||||
DOTMANTYPESRC=$(shell ls $(DOTTYPEDIR)/*/man.rst)
|
||||
$(info $(DOTMANTYPESRC))
|
||||
DOTMANTYPEPREFIX=$(subst $(DOTTYPEDIR)/,$(DOTMAN7DSTDIR)/cdist-type,$(DOTMANTYPESRC))
|
||||
$(info $(DOTMANTYPEPREFIX))
|
||||
DOTMANTYPES=$(subst /man.rst,.rst,$(DOTMANTYPEPREFIX))
|
||||
$(info $(DOTMANTYPES))
|
||||
|
||||
# Link manpage: do not create man.html but correct named file
|
||||
$(DOTMAN7DSTDIR)/cdist-type%.rst: $(DOTTYPEDIR)/%/man.rst
|
||||
ln -sf "$^" $@
|
||||
|
||||
# Manpages #3: generic part
|
||||
dotmansphinxman: $(DOTMANTYPES)
|
||||
$(SPHINXM)
|
||||
|
||||
dotman: dotmansphinxman
|
||||
|
||||
|
||||
################################################################################
|
||||
# Speeches
|
||||
#
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__apt_key(7)
|
||||
======================
|
||||
Manage the list of keys used by apt
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__apt_key - Manage the list of keys used by apt
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__apt_key_uri(7)
|
||||
==========================
|
||||
Add apt key from uri
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__apt_key_uri - Add apt key from uri
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__apt_norecommends(7)
|
||||
===============================
|
||||
Configure apt to not install recommended packages
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__apt_norecommends - Configure apt to not install recommended packages
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__apt_ppa(7)
|
||||
======================
|
||||
Manage ppa repositories
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__apt_ppa - Manage ppa repositories
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__apt_source(7)
|
||||
=========================
|
||||
Manage apt sources
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__apt_source - Manage apt sources
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__apt_update_index(7)
|
||||
===============================
|
||||
Update apt's package index
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__apt_update_index - Update apt's package index
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__block(7)
|
||||
====================
|
||||
Manage blocks of text in files
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__block - Manage blocks of text in files
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__ccollect_source(7)
|
||||
==============================
|
||||
Manage ccollect sources
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__ccollect_source - Manage ccollect sources
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__cdist(7)
|
||||
====================
|
||||
Manage cdist installations
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__cdist - Manage cdist installations
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__cdistmarker(7)
|
||||
==========================
|
||||
Add a timestamped cdist marker.
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__cdistmarker - Add a timestamped cdist marker.
|
||||
|
||||
Daniel Maher <phrawzty+cdist--@--gmail.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__config_file(7)
|
||||
==========================
|
||||
Manages config files
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__config_file - _Manages config files
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul(7)
|
||||
=====================
|
||||
Install consul
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul - Install consul
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_agent(7)
|
||||
===========================
|
||||
Manage the consul agent
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_agent - Manage the consul agent
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_check(7)
|
||||
=============================
|
||||
Manages consul checks
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_check - Manages consul checks
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_reload(7)
|
||||
============================
|
||||
Reload consul
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_reload - Reload consul
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_service(7)
|
||||
=============================
|
||||
Manages consul services
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_service - Manages consul services
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_template(7)
|
||||
==============================
|
||||
Manage the consul-template service
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_template - Manage the consul-template service
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_template_template(7)
|
||||
=======================================
|
||||
Manage consul-template templates
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_template_template - Manage consul-template templates
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_watch_checks(7)
|
||||
==================================
|
||||
Manages consul checks watches
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_watch_checks - Manages consul checks watches
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_watch_event(7)
|
||||
=================================
|
||||
Manages consul event watches
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_watch_event - Manages consul event watches
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_watch_key(7)
|
||||
===============================
|
||||
Manages consul key watches
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_watch_key - Manages consul key watches
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_watch_keyprefix(7)
|
||||
=====================================
|
||||
Manages consul keyprefix watches
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_watch_keyprefix - Manages consul keyprefix watches
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_watch_nodes(7)
|
||||
=================================
|
||||
Manages consul nodes watches
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_watch_nodes - Manages consul nodes watches
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_watch_service(7)
|
||||
===================================
|
||||
Manages consul service watches
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_watch_service - Manages consul service watches
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__consul_watch_services(7)
|
||||
====================================
|
||||
Manages consul services watches
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__consul_watch_services - Manages consul services watches
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__cron(7)
|
||||
===================
|
||||
Installs and manages cron jobs
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__cron - Installs and manages cron jobs
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__debconf_set_selections(7)
|
||||
=====================================
|
||||
Setup debconf selections
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__debconf_set_selections - Setup debconf selections
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__directory(7)
|
||||
========================
|
||||
Manage a directory
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__directory - Manage a directory
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__dog_vdi(7)
|
||||
======================
|
||||
Manage Sheepdog VM images
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__dog_vdi - Manage Sheepdog VM images
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__file(7)
|
||||
===================
|
||||
Manage files.
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__file - Manage files.
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__firewalld_rule(7)
|
||||
=============================
|
||||
Configure firewalld rules
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__firewalld_rule - Configure firewalld rules
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__git(7)
|
||||
==================
|
||||
Get and or keep git repositories up-to-date
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__git - Get and or keep git repositories up-to-date
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__group(7)
|
||||
====================
|
||||
Manage groups
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__group - Manage groups
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__hostname(7)
|
||||
=======================
|
||||
Set the hostname
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__hostname - Set the hostname
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__iptables_apply(7)
|
||||
=============================
|
||||
Apply the rules
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__iptables_apply - Apply the rules
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__iptables_rule(7)
|
||||
============================
|
||||
Deploy iptable rulesets
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__iptables_rule - Deploy iptable rulesets
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__issue(7)
|
||||
====================
|
||||
Manage issue
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__issue - Manage issue
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__jail(7)
|
||||
===================
|
||||
Manage FreeBSD jails
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__jail - Manage FreeBSD jails
|
||||
|
||||
Jake Guffey <jake.guffey--@--jointheirstm.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__jail_freebsd10(7)
|
||||
=============================
|
||||
Manage FreeBSD jails
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__jail_freeebsd10 - Manage FreeBSD jails
|
||||
|
||||
Jake Guffey <jake.guffey--@--jointheirstm.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__jail_freebsd9(7)
|
||||
============================
|
||||
Manage FreeBSD jails
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__jail_freebsd9 - Manage FreeBSD jails
|
||||
|
||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__key_value(7)
|
||||
========================
|
||||
Change property values in files
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__key_value - Change property values in files
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__line(7)
|
||||
===================
|
||||
Manage lines in files
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__line - Manage lines in files
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__link(7)
|
||||
===================
|
||||
Manage links (hard and symbolic)
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__link - Manage links (hard and symbolic)
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__locale(7)
|
||||
=====================
|
||||
Configure locales
|
||||
|
||||
NAME
|
||||
----
|
||||
cdit-type__locale - Configure locales
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__motd(7)
|
||||
===================
|
||||
Manage message of the day
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__motd - Manage message of the day
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__mount(7)
|
||||
====================
|
||||
Manage filesystem mounts
|
||||
|
||||
NAME
|
||||
----
|
||||
cdit-type__mount - Manage filesystem mounts
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__mysql_database(7)
|
||||
=============================
|
||||
Manage a MySQL database
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__mysql_database - Manage a MySQL database
|
||||
|
||||
Benedikt Koeppel <code@benediktkoeppel.ch>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package(7)
|
||||
======================
|
||||
Manage packages
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package - Manage packages
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_apt(7)
|
||||
==========================
|
||||
Manage packages with apt-get
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_apt - Manage packages with apt-get
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_emerge(7)
|
||||
=============================
|
||||
Manage packages with portage
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_emerge - Manage packages with portage
|
||||
|
||||
Thomas Oettli <otho--@--sfs.biz>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_emerge_dependencies(7)
|
||||
==========================================
|
||||
Install dependencies for __package_emerge
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_emerge_dependencies - Install dependencies for __package_emerge
|
||||
|
||||
Thomas Oettli <otho--@--sfs.biz>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_luarocks(7)
|
||||
===============================
|
||||
Manage luarocks packages
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_luarocks - Manage luarocks packages
|
||||
|
||||
Christian G. Warden <cwarden@xerus.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_opkg(7)
|
||||
===========================
|
||||
Manage packages with opkg
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_opkg - Manage packages with opkg
|
||||
|
||||
Giel van Schijndel <giel+cdist--@--mortis.eu>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_pacman(7)
|
||||
=============================
|
||||
Manage packages with pacman
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_pacman - Manage packages with pacman
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_pip(7)
|
||||
==========================
|
||||
Manage packages with pip
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_pip - Manage packages with pip
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_pkg_freebsd(7)
|
||||
==================================
|
||||
Manage FreeBSD packages
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_pkg_freebsd - Manage FreeBSD packages
|
||||
|
||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_pkg(7)
|
||||
==========================
|
||||
Manage OpenBSD packages
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_pkg - Manage OpenBSD packages
|
||||
|
||||
Andi Brönnimann <andi-cdist--@--v-net.ch>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_pkgng_freebsd(7)
|
||||
====================================
|
||||
Manage FreeBSD packages with pkg-ng
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_pkgng_freebsd - Manage FreeBSD packages with pkg-ng
|
||||
|
||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_rubygem(7)
|
||||
==============================
|
||||
Manage rubygem packages
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_rubygem - Manage rubygem packages
|
||||
|
||||
Chase Allen James <nx-cdist@nu-ex.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_update_index(7)
|
||||
===================================
|
||||
Update the package index
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__update_index - Update the package index
|
||||
|
||||
Ricardo Catalinas Jiménez <jimenezrick--@--gmail.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_upgrade_all(7)
|
||||
==================================
|
||||
Upgrade all the installed packages
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_upgrade_all - Upgrade all the installed packages
|
||||
|
||||
Ricardo Catalinas Jiménez <jimenezrick--@--gmail.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_yum(7)
|
||||
==========================
|
||||
Manage packages with yum
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_yum - Manage packages with yum
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__package_zypper(7)
|
||||
=============================
|
||||
Manage packages with zypper
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__package_zypper - Manage packages with zypper
|
||||
|
||||
Daniel Heule <hda--@--sfs.biz>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__pacman_conf(7)
|
||||
==========================
|
||||
Manage pacman configuration
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__pacman_conf - Manage pacman configuration
|
||||
|
||||
Dominique Roux <dominique.roux4@gmail.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__pacman_conf_integrate(7)
|
||||
====================================
|
||||
Integrate default pacman.conf to cdist conform and vice versa
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__pacman_conf_integrate - Integrate default pacman.conf to cdist conform and vice versa
|
||||
|
||||
Dominique Roux <dominique.roux4@gmail.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,11 @@
|
|||
cdist-type__pf_apply(7)
|
||||
=======================
|
||||
Apply pf(4) ruleset on \*BSD
|
||||
|
||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__pf_apply - Apply pf(4) ruleset on \*BSD
|
||||
|
||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__pf_ruleset(7)
|
||||
=========================
|
||||
Copy a pf(4) ruleset to $__target_host
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__pf_ruleset - Copy a pf(4) ruleset to $__target_host
|
||||
|
||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__postfix(7)
|
||||
======================
|
||||
Install postfix
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__postfix - Install postfix
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__postfix_master(7)
|
||||
=============================
|
||||
Configure postfix master.cf
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__postfix_master - Configure postfix master.cf
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__postfix_postconf(7)
|
||||
===============================
|
||||
Configure postfix main.cf
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__postfix_postconf - Configure postfix main.cf
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__postfix_postmap(7)
|
||||
==============================
|
||||
Run postmap on the given file
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__postfix_postmap - Run postmap on the given file
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__postfix_reload(7)
|
||||
=============================
|
||||
Tell postfix to reload its configuration
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__postfix_reload - Tell postfix to reload its configuration
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__postgres_database(7)
|
||||
================================
|
||||
Create/drop postgres databases
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__postgres_database - Create/drop postgres databases
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__postgres_role(7)
|
||||
============================
|
||||
Manage postgres roles
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__postgres_role - Manage postgres roles
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__process(7)
|
||||
======================
|
||||
Start or stop process
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__process - Start or stop process
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__pyvenv(7)
|
||||
=====================
|
||||
Create or remove python virtual environment
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__pyvenv - Create or remove python virtual environment
|
||||
|
||||
Darko Poljak <darko.poljak--@--gmail.com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__qemu_img(7)
|
||||
=======================
|
||||
Manage VM disk images
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__qemu_img - Manage VM disk images
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__rbenv(7)
|
||||
====================
|
||||
Manage rbenv installation
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__rbenv - Manage rbenv installation
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__rsync(7)
|
||||
====================
|
||||
Mirror directories using rsync
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__rsync - Mirror directories using rsync
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__rvm(7)
|
||||
==================
|
||||
Install rvm for a given user
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__rvm - Install rvm for a given user
|
||||
|
||||
Evax Software <contact@evax.fr>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__rvm_gemset(7)
|
||||
==========================
|
||||
Manage Ruby gems through rvm
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__rvm_gemset - Manage Ruby gems through rvm
|
||||
|
||||
Evax Software <contact@evax.fr>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__rvm_gemset(7)
|
||||
==========================
|
||||
Manage gemsets through rvm
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__rvm_gemset - Manage gemsets through rvm
|
||||
|
||||
Evax Software <contact@evax.fr>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__rvm_ruby(7)
|
||||
=======================
|
||||
Manage ruby installations through rvm
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__rvm_ruby - Manage ruby installations through rvm
|
||||
|
||||
Evax Software <contact@evax.fr>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__ssh_authorized_key(7)
|
||||
=================================
|
||||
Manage a single ssh authorized key entry
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__ssh_authorized_key - Manage a single ssh authorized key entry
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__ssh_authorized_keys(7)
|
||||
==================================
|
||||
Manage ssh authorized_keys files
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__ssh_authorized_keys - Manage ssh authorized_keys files
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,11 @@
|
|||
cdist-type__ssh_dot_ssh(7)
|
||||
==========================
|
||||
Manage .ssh directory
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__ssh_dot_ssh - Manage .ssh directory
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__staged_file(7)
|
||||
==========================
|
||||
Manage staged files
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__staged_file - Manage staged files
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__start_on_boot(7)
|
||||
============================
|
||||
Manage stuff to be started at boot
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__start_on_boot - Manage stuff to be started at boot
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__timezone(7)
|
||||
=======================
|
||||
Allows one to configure the desired localtime timezone.
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__timezone - Allows one to configure the desired localtime timezone.
|
||||
|
||||
Ramon Salvadó <rsalvado--@--gnuine--dot--com>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__update_alternatives(7)
|
||||
==================================
|
||||
Configure alternatives
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__update_alternatives - Configure alternatives
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__user(7)
|
||||
===================
|
||||
Manage users
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__user - Manage users
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__user_groups(7)
|
||||
==========================
|
||||
Manage user groups
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__user_groups - Manage user groups
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__yum_repo(7)
|
||||
=======================
|
||||
Manage yum repositories
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__yum_repo - Manage yum repositories
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__zypper_repo(7)
|
||||
==========================
|
||||
Repository management with zypper
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__zypper_repo - Repository management with zypper
|
||||
|
||||
Daniel Heule <hda--@--sfs.biz>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
cdist-type__zypper_service(7)
|
||||
=============================
|
||||
Service management with zypper
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__zypper_service - Service management with zypper
|
||||
|
||||
Daniel Heule <hda--@--sfs.biz>
|
||||
|
||||
|
|
|
|||
0
cdist/sphinxext/__init__.py
Normal file
0
cdist/sphinxext/__init__.py
Normal file
80
cdist/sphinxext/manpage.py
Normal file
80
cdist/sphinxext/manpage.py
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
import sphinx.builders.manpage
|
||||
import sphinx.writers.manpage
|
||||
from docutils.frontend import OptionParser
|
||||
from sphinx.util.console import bold, darkgreen
|
||||
from six import string_types
|
||||
from docutils.io import FileOutput
|
||||
from os import path
|
||||
from sphinx.util.nodes import inline_all_toctrees
|
||||
from sphinx import addnodes
|
||||
|
||||
"""
|
||||
Extension based on sphinx builtin manpage.
|
||||
It does not write its own .SH NAME based on config,
|
||||
but leaves everything to actual reStructuredText file content.
|
||||
"""
|
||||
|
||||
class ManualPageTranslator(sphinx.writers.manpage.ManualPageTranslator):
|
||||
|
||||
def header(self):
|
||||
tmpl = (".TH \"%(title_upper)s\" \"%(manual_section)s\""
|
||||
" \"%(date)s\" \"%(version)s\" \"%(manual_group)s\"\n")
|
||||
return tmpl % self._docinfo
|
||||
|
||||
|
||||
class ManualPageWriter(sphinx.writers.manpage.ManualPageWriter):
|
||||
|
||||
def __init__(self, builder):
|
||||
super().__init__(builder)
|
||||
self.translator_class = (
|
||||
self.builder.translator_class or ManualPageTranslator)
|
||||
|
||||
|
||||
class ManualPageBuilder(sphinx.builders.manpage.ManualPageBuilder):
|
||||
|
||||
name = 'cman'
|
||||
|
||||
def write(self, *ignored):
|
||||
docwriter = ManualPageWriter(self)
|
||||
docsettings = OptionParser(
|
||||
defaults=self.env.settings,
|
||||
components=(docwriter,),
|
||||
read_config_files=True).get_default_values()
|
||||
|
||||
self.info(bold('writing... '), nonl=True)
|
||||
|
||||
for info in self.config.man_pages:
|
||||
docname, name, description, authors, section = info
|
||||
if isinstance(authors, string_types):
|
||||
if authors:
|
||||
authors = [authors]
|
||||
else:
|
||||
authors = []
|
||||
|
||||
targetname = '%s.%s' % (name, section)
|
||||
self.info(darkgreen(targetname) + ' { ', nonl=True)
|
||||
destination = FileOutput(
|
||||
destination_path=path.join(self.outdir, targetname),
|
||||
encoding='utf-8')
|
||||
|
||||
tree = self.env.get_doctree(docname)
|
||||
docnames = set()
|
||||
largetree = inline_all_toctrees(self, docnames, docname, tree,
|
||||
darkgreen, [docname])
|
||||
self.info('} ', nonl=True)
|
||||
self.env.resolve_references(largetree, docname, self)
|
||||
# remove pending_xref nodes
|
||||
for pendingnode in largetree.traverse(addnodes.pending_xref):
|
||||
pendingnode.replace_self(pendingnode.children)
|
||||
|
||||
largetree.settings = docsettings
|
||||
largetree.settings.title = name
|
||||
largetree.settings.subtitle = description
|
||||
largetree.settings.authors = authors
|
||||
largetree.settings.section = section
|
||||
|
||||
docwriter.write(largetree, destination)
|
||||
self.info()
|
||||
|
||||
def setup(app):
|
||||
app.add_builder(ManualPageBuilder)
|
||||
|
|
@ -161,7 +161,7 @@ text:
|
|||
|
||||
.PHONY: man
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
$(SPHINXBUILD) -b cman $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,10 @@ exec > "$dest"
|
|||
cat << eof
|
||||
cdist-reference(7)
|
||||
==================
|
||||
Variable, path and type reference for cdist
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-reference - Variable, path and type reference for cdist
|
||||
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue