aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2013-04-22 08:45:48 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2013-04-22 08:45:48 +0300
commita49589c88d56ee281d102722dfb4a3cafaa0e4de (patch)
treee1895056f53e618298fc91099134987aac619ba2 /doc
parent57cfa4ef673adf0233f238ec6e6b16fca3061532 (diff)
downloadeclat-a49589c88d56ee281d102722dfb4a3cafaa0e4de.tar.gz
eclat-a49589c88d56ee281d102722dfb4a3cafaa0e4de.tar.bz2
Automate generation of command lists in the docs.
* src/.gitignore: Add generated *.man files. * src/Makefile.am (comtab.man,xref.man): Generate auxiliary man files for inclusion into eclat.1 * doc/.gitignore: New file. * doc/Makefile.am: Generate eclat.1 from eclat.1man by including two auxiliary files from src * doc/eclat.1: Rename to doc/eclat.1man * doc/eclat.1man: Replace the list of eclat commands and the "see also" list by the .so requests.
Diffstat (limited to 'doc')
-rw-r--r--doc/.gitignore3
-rw-r--r--doc/Makefile.am4
-rw-r--r--doc/eclat.1man (renamed from doc/eclat.1)72
3 files changed, 10 insertions, 69 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..c3e2c16
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,3 @@
+*.ps
+*.pdf
+eclat.1
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 0d08de5..e93097b 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -52,3 +52,7 @@ MANPAGES5=\
dist_man_MANS=$(MANPAGES1) $(MANPAGES5)
+eclat.1: eclat.1man $(top_srcdir)/src/comtab.man $(top_srcdir)/src/xref.man
+ $(AM_V_GEN)soelim -I $(top_srcdir)/src eclat.1man > eclat.1
+
+EXTRA_DIST = eclat.1 eclat.1man
diff --git a/doc/eclat.1 b/doc/eclat.1man
index bc75698..e63df2b 100644
--- a/doc/eclat.1
+++ b/doc/eclat.1man
@@ -13,7 +13,7 @@
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with Eclat. If not, see <http://www.gnu.org/licenses/>.
-.TH ECLAT 1 "April 20, 2013" "ECLAT" "Eclat User Reference"
+.TH ECLAT 1 "April 22, 2013" "ECLAT" "Eclat User Reference"
.SH NAME
eclat \- EC2 Command Line Administrator Tool
.SH SYNOPSIS
@@ -258,40 +258,7 @@ commands are implemented:
.ta 8n 20n
.ul
Eclat name EC2 name
- \fBallocaddr\fR \fBallocate\-address\fR
- \fBassocaddr\fR \fBassociate\-address\fR
- \fBatvol\fR \fBattach\-volume\fR
- \fBmkimg\fR \fBcreate\-image\fR
- \fBmksnap\fR \fBcreate\-snapshot\fR
- \fBmktag\fR \fBcreate\-tags\fR
- \fBmkvol\fR \fBcreate\-volume\fR
- \fBrmsnap\fR \fBdelete\-snapshot\fR
- \fBrmtag\fR \fBdelete\-tags\fR
- \fBrmvol\fR \fBdelete\-volume\fR
- \fBdeimg\fR \fBderegister\-image\fR
- \fBlsaddr\fR \fBdescribe\-addresses\fR
- \fBlszon\fR \fBdescribe\-availability\-zones\fR
- \fBlsimg\fR \fBdescribe\-images\fR
- \fBlsiattr\fR \fBdescribe\-instance\-attribute\fR
- \fBlsistat\fR \fBdescribe\-instance\-status\fR
- \fBlsinst\fR \fBdescribe\-instances\fR
- \fBlsreg\fR \fBdescribe\-regions\fR
- \fBlssg\fR \fBdescribe\-security\-groups\fR
- \fBlssattr\fR \fBdescribe\-snapshot\-attribute\fR
- \fBlssnap\fR \fBdescribe\-snapshots\fR
- \fBlstag\fR \fBdescribe\-tags\fR
- \fBlsvol\fR \fBdescribe\-volumes\fR
- \fBdevol\fR \fBdetach\-volume\fR
- \fBdisasaddr\fR \fBdisassociate\-address\fR
- \fBconmesg\fR \fBget\-console\-output\fR
- \fBsetiattr\fR \fBmodify\-instance\-attribute\fR
- \fBsetsattr\fR \fBmodify\-snapshot\-attribute\fR
- \fBreboot\fR \fBreboot\-instances\fR
- \fBfreeaddr\fR \fBrelease\-address\fR
- \fBclrsattr\fR \fBreset\-snapshot\-attribute\fR
- \fBmkinst\fR \fBrun\-instances\fR
- \fBstart\fR \fBstart\-instances\fR
- \fBstop\fR \fBstop\-instances\fR
+.so comtab.man
.fi
.PP
Each command understands a \fB\-\-help\fR (\fB\-h\fR) command line
@@ -518,40 +485,7 @@ can contain a list of default options for
These options are processed before the actual command line options.
.SH "SEE ALSO"
.BR eclat.conf (5),
-.BR eclat-allocaddr (1),
-.BR eclat-assocaddr (1),
-.BR eclat-atvol (1),
-.BR eclat-mkimg (1),
-.BR eclat-mksnap (1),
-.BR eclat-mktag (1),
-.BR eclat-mkvol (1),
-.BR eclat-rmsnap (1),
-.BR eclat-rmtag (1),
-.BR eclat-rmvol (1),
-.BR eclat-deimg (1),
-.BR eclat-lsaddr (1),
-.BR eclat-lszon (1),
-.BR eclat-lsimg (1),
-.BR eclat-lsiattr (1),
-.BR eclat-lsistat (1),
-.BR eclat-lsinst (1),
-.BR eclat-lsreg (1),
-.BR eclat-lssg (1),
-.BR eclat-lssattr (1),
-.BR eclat-lssnap (1),
-.BR eclat-lstag (1),
-.BR eclat-lsvol (1),
-.BR eclat-devol (1),
-.BR eclat-disasaddr (1),
-.BR eclat-conmesg (1),
-.BR eclat-setiattr (1),
-.BR eclat-setsattr (1),
-.BR eclat-reboot (1),
-.BR eclat-freeaddr (1),
-.BR eclat-clrsattr (1),
-.BR eclat-mkinst (1),
-.BR eclat-start (1),
-.BR eclat-stop (1),
+.so xref.man
.BR forlan (5).
.SH AUTHORS
Sergey Poznyakoff

Return to:

Send suggestions and report system problems to the System administrator.