[bwm-tools-devel] COMMIT - r34 - trunk/doc
Brought to you by:
nkukard
Menu
▾
▴
[bwm-tools-devel] COMMIT - r34 - trunk/doc
|
From: SVN C. <sv...@li...> - 2005-01-10 12:01:12
|
Author: nkukard
Date: 2005-01-10 14:00:08 +0200 (Mon, 10 Jan 2005)
New Revision: 34
Added:
trunk/doc/Makefile.am
trunk/doc/Makefile.in
trunk/doc/bwmtools.info
trunk/doc/bwmtools.texi
trunk/doc/fdl.texi
trunk/doc/mdate-sh
trunk/doc/stamp-vti
trunk/doc/texinfo.tex
trunk/doc/version.texi
Modified:
trunk/doc/example.xml
Log:
* Fixed bug in example.xml
* Added bwmtools texinfo manual
Added: trunk/doc/Makefile.am
===================================================================
--- trunk/doc/Makefile.am 2005-01-09 16:23:48 UTC (rev 33)
+++ trunk/doc/Makefile.am 2005-01-10 12:00:08 UTC (rev 34)
@@ -0,0 +1,24 @@
+#
+# makefile.am - Makefile for documentation
+# Copyright (C) 2003-2005, Linux Based Systems Design
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+
+
+EXTRA_DIST = Configuration Install example.xml
+
+info_TEXINFOS = bwmtools.texi
+
Added: trunk/doc/Makefile.in
===================================================================
--- trunk/doc/Makefile.in 2005-01-09 16:23:48 UTC (rev 33)
+++ trunk/doc/Makefile.in 2005-01-10 12:00:08 UTC (rev 34)
@@ -0,0 +1,517 @@
+# Makefile.in generated by automake 1.9.1 from Makefile.am.
+# @configure_input@
+
+# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
+# 2003, 2004 Free Software Foundation, Inc.
+# This Makefile.in is free software; the Free Software Foundation
+# gives unlimited permission to copy and/or distribute it,
+# with or without modifications, as long as this notice is preserved.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+# PARTICULAR PURPOSE.
+
+@SET_MAKE@
+
+#
+# makefile.am - Makefile for documentation
+# Copyright (C) 2003-2005, Linux Based Systems Design
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+srcdir = @srcdir@
+top_srcdir = @top_srcdir@
+VPATH = @srcdir@
+pkgdatadir = $(datadir)/@PACKAGE@
+pkglibdir = $(libdir)/@PACKAGE@
+pkgincludedir = $(includedir)/@PACKAGE@
+top_builddir = ..
+am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd
+INSTALL = @INSTALL@
+install_sh_DATA = $(install_sh) -c -m 644
+install_sh_PROGRAM = $(install_sh) -c
+install_sh_SCRIPT = $(install_sh) -c
+INSTALL_HEADER = $(INSTALL_DATA)
+transform = $(program_transform_name)
+NORMAL_INSTALL = :
+PRE_INSTALL = :
+POST_INSTALL = :
+NORMAL_UNINSTALL = :
+PRE_UNINSTALL = :
+POST_UNINSTALL = :
+build_triplet = @build@
+host_triplet = @host@
+subdir = doc
+DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \
+ $(srcdir)/stamp-vti $(srcdir)/version.texi mdate-sh \
+ texinfo.tex
+ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
+am__aclocal_m4_deps = $(top_srcdir)/configure.ac
+am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
+ $(ACLOCAL_M4)
+mkinstalldirs = $(install_sh) -d
+CONFIG_HEADER = $(top_builddir)/config.h
+CONFIG_CLEAN_FILES =
+SOURCES =
+DIST_SOURCES =
+INFO_DEPS = $(srcdir)/bwmtools.info
+am__TEXINFO_TEX_DIR = $(srcdir)
+DVIS = bwmtools.dvi
+PDFS = bwmtools.pdf
+PSS = bwmtools.ps
+HTMLS = bwmtools.html
+TEXINFOS = bwmtools.texi
+TEXI2DVI = texi2dvi
+TEXI2PDF = $(TEXI2DVI) --pdf --batch
+MAKEINFOHTML = $(MAKEINFO) --html
+AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS)
+DVIPS = dvips
+am__installdirs = "$(DESTDIR)$(infodir)"
+DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
+ACLOCAL = @ACLOCAL@
+ALLOCA = @ALLOCA@
+AMDEP_FALSE = @AMDEP_FALSE@
+AMDEP_TRUE = @AMDEP_TRUE@
+AMTAR = @AMTAR@
+AR = @AR@
+AUTOCONF = @AUTOCONF@
+AUTOHEADER = @AUTOHEADER@
+AUTOMAKE = @AUTOMAKE@
+AWK = @AWK@
+CC = @CC@
+CCDEPMODE = @CCDEPMODE@
+CFLAGS = @CFLAGS@
+CPP = @CPP@
+CPPFLAGS = @CPPFLAGS@
+CXX = @CXX@
+CXXCPP = @CXXCPP@
+CXXDEPMODE = @CXXDEPMODE@
+CXXFLAGS = @CXXFLAGS@
+CYGPATH_W = @CYGPATH_W@
+DEFS = @DEFS@
+DEPDIR = @DEPDIR@
+ECHO = @ECHO@
+ECHO_C = @ECHO_C@
+ECHO_N = @ECHO_N@
+ECHO_T = @ECHO_T@
+EGREP = @EGREP@
+EXEEXT = @EXEEXT@
+F77 = @F77@
+FFLAGS = @FFLAGS@
+GLIB_CFLAGS = @GLIB_CFLAGS@
+GLIB_GENMARSHAL = @GLIB_GENMARSHAL@
+GLIB_LIBS = @GLIB_LIBS@
+GLIB_MKENUMS = @GLIB_MKENUMS@
+GOBJECT_QUERY = @GOBJECT_QUERY@
+INSTALL_DATA = @INSTALL_DATA@
+INSTALL_PROGRAM = @INSTALL_PROGRAM@
+INSTALL_SCRIPT = @INSTALL_SCRIPT@
+INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
+LDFLAGS = @LDFLAGS@
+LIBOBJS = @LIBOBJS@
+LIBS = @LIBS@
+LIBTOOL = @LIBTOOL@
+LN_S = @LN_S@
+LTLIBOBJS = @LTLIBOBJS@
+MAKEINFO = @MAKEINFO@
+OBJEXT = @OBJEXT@
+PACKAGE = @PACKAGE@
+PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@
+PACKAGE_NAME = @PACKAGE_NAME@
+PACKAGE_STRING = @PACKAGE_STRING@
+PACKAGE_TARNAME = @PACKAGE_TARNAME@
+PACKAGE_VERSION = @PACKAGE_VERSION@
+PATH_SEPARATOR = @PATH_SEPARATOR@
+PKG_CONFIG = @PKG_CONFIG@
+RANLIB = @RANLIB@
+RRDTOOL_LIBS = @RRDTOOL_LIBS@
+SET_MAKE = @SET_MAKE@
+SHELL = @SHELL@
+STRIP = @STRIP@
+VERSION = @VERSION@
+XML2_CONFIG = @XML2_CONFIG@
+XML_CFLAGS = @XML_CFLAGS@
+XML_CPPFLAGS = @XML_CPPFLAGS@
+XML_LIBS = @XML_LIBS@
+ac_ct_AR = @ac_ct_AR@
+ac_ct_CC = @ac_ct_CC@
+ac_ct_CXX = @ac_ct_CXX@
+ac_ct_F77 = @ac_ct_F77@
+ac_ct_RANLIB = @ac_ct_RANLIB@
+ac_ct_STRIP = @ac_ct_STRIP@
+am__fastdepCC_FALSE = @am__fastdepCC_FALSE@
+am__fastdepCC_TRUE = @am__fastdepCC_TRUE@
+am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@
+am__fastdepCXX_TRUE = @am__fastdepCXX_TRUE@
+am__include = @am__include@
+am__leading_dot = @am__leading_dot@
+am__quote = @am__quote@
+am__tar = @am__tar@
+am__untar = @am__untar@
+bindir = @bindir@
+build = @build@
+build_alias = @build_alias@
+build_cpu = @build_cpu@
+build_os = @build_os@
+build_vendor = @build_vendor@
+datadir = @datadir@
+exec_prefix = @exec_prefix@
+host = @host@
+host_alias = @host_alias@
+host_cpu = @host_cpu@
+host_os = @host_os@
+host_vendor = @host_vendor@
+includedir = @includedir@
+infodir = @infodir@
+install_sh = @install_sh@
+libdir = @libdir@
+libexecdir = @libexecdir@
+localstatedir = @localstatedir@
+mandir = @mandir@
+mkdir_p = @mkdir_p@
+oldincludedir = @oldincludedir@
+prefix = @prefix@
+program_transform_name = @program_transform_name@
+sbindir = @sbindir@
+sharedstatedir = @sharedstatedir@
+sysconfdir = @sysconfdir@
+target_alias = @target_alias@
+EXTRA_DIST = Configuration Install example.xml
+info_TEXINFOS = bwmtools.texi
+all: all-am
+
+.SUFFIXES:
+.SUFFIXES: .dvi .html .info .pdf .ps .texi
+$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps)
+ @for dep in $?; do \
+ case '$(am__configure_deps)' in \
+ *$$dep*) \
+ cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \
+ && exit 0; \
+ exit 1;; \
+ esac; \
+ done; \
+ echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \
+ cd $(top_srcdir) && \
+ $(AUTOMAKE) --gnu doc/Makefile
+.PRECIOUS: Makefile
+Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
+ @case '$?' in \
+ *config.status*) \
+ cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \
+ *) \
+ echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \
+ cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \
+ esac;
+
+$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES)
+ cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
+
+$(top_srcdir)/configure: $(am__configure_deps)
+ cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
+$(ACLOCAL_M4): $(am__aclocal_m4_deps)
+ cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
+
+mostlyclean-libtool:
+ -rm -f *.lo
+
+clean-libtool:
+ -rm -rf .libs _libs
+
+distclean-libtool:
+ -rm -f libtool
+
+.texi.info:
+ restore=: && backupdir="$(am__leading_dot)am$$$$" && \
+ am__cwd=`pwd` && cd $(srcdir) && \
+ rm -rf $$backupdir && mkdir $$backupdir && \
+ for f in $@ $@-[0-9] $@-[0-9][0-9] $(@:.info=).i[0-9] $(@:.info=).i[0-9][0-9]; do \
+ if test -f $$f; then mv $$f $$backupdir; restore=mv; else :; fi; \
+ done; \
+ cd "$$am__cwd"; \
+ if $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \
+ -o $@ $<; \
+ then \
+ rc=0; \
+ cd $(srcdir); \
+ else \
+ rc=$$?; \
+ cd $(srcdir) && \
+ $$restore $$backupdir/* `echo "./$@" | sed 's|[^/]*$$||'`; \
+ fi; \
+ rm -rf $$backupdir; exit $$rc
+
+.texi.dvi:
+ TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \
+ MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir)' \
+ $(TEXI2DVI) $<
+
+.texi.pdf:
+ TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \
+ MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir)' \
+ $(TEXI2PDF) $<
+
+.texi.html:
+ rm -rf $(@:.html=.htp)
+ if $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \
+ -o $(@:.html=.htp) $<; \
+ then \
+ rm -rf $@; \
+ if test ! -d $(@:.html=.htp) && test -d $(@:.html=); then \
+ mv $(@:.html=) $@; else mv $(@:.html=.htp) $@; fi; \
+ else \
+ if test ! -d $(@:.html=.htp) && test -d $(@:.html=); then \
+ rm -rf $(@:.html=); else rm -Rf $(@:.html=.htp) $@; fi; \
+ exit 1; \
+ fi
+$(srcdir)/bwmtools.info: bwmtools.texi $(srcdir)/version.texi
+bwmtools.dvi: bwmtools.texi $(srcdir)/version.texi
+bwmtools.pdf: bwmtools.texi $(srcdir)/version.texi
+bwmtools.html: bwmtools.texi $(srcdir)/version.texi
+$(srcdir)/version.texi: $(srcdir)/stamp-vti
+$(srcdir)/stamp-vti: bwmtools.texi $(top_srcdir)/configure
+ @(dir=.; test -f ./bwmtools.texi || dir=$(srcdir); \
+ set `$(SHELL) $(srcdir)/mdate-sh $$dir/bwmtools.texi`; \
+ echo "@set UPDATED $$1 $$2 $$3"; \
+ echo "@set UPDATED-MONTH $$2 $$3"; \
+ echo "@set EDITION $(VERSION)"; \
+ echo "@set VERSION $(VERSION)") > vti.tmp
+ @cmp -s vti.tmp $(srcdir)/version.texi \
+ || (echo "Updating $(srcdir)/version.texi"; \
+ cp vti.tmp $(srcdir)/version.texi)
+ -@rm -f vti.tmp
+ @cp $(srcdir)/version.texi $@
+
+mostlyclean-vti:
+ -rm -f vti.tmp
+
+maintainer-clean-vti:
+ -rm -f $(srcdir)/stamp-vti $(srcdir)/version.texi
+.dvi.ps:
+ $(DVIPS) -o $@ $<
+
+uninstall-info-am:
+ $(PRE_UNINSTALL)
+ @if (install-info --version && \
+ install-info --version 2>&1 | sed 1q | grep -i -v debian) >/dev/null 2>&1; then \
+ list='$(INFO_DEPS)'; \
+ for file in $$list; do \
+ relfile=`echo "$$file" | sed 's|^.*/||'`; \
+ echo " install-info --info-dir='$(DESTDIR)$(infodir)' --remove '$(DESTDIR)$(infodir)/$$relfile'"; \
+ install-info --info-dir="$(DESTDIR)$(infodir)" --remove "$(DESTDIR)$(infodir)/$$relfile"; \
+ done; \
+ else :; fi
+ @$(NORMAL_UNINSTALL)
+ @list='$(INFO_DEPS)'; \
+ for file in $$list; do \
+ relfile=`echo "$$file" | sed 's|^.*/||'`; \
+ relfile_i=`echo "$$relfile" | sed 's|\.info$$||;s|$$|.i|'`; \
+ (if cd "$(DESTDIR)$(infodir)"; then \
+ echo " rm -f $$relfile $$relfile-[0-9] $$relfile-[0-9][0-9] $$relfile_i[0-9] $$relfile_i[0-9][0-9])"; \
+ rm -f $$relfile $$relfile-[0-9] $$relfile-[0-9][0-9] $$relfile_i[0-9] $$relfile_i[0-9][0-9]; \
+ else :; fi); \
+ done
+
+dist-info: $(INFO_DEPS)
+ @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \
+ list='$(INFO_DEPS)'; \
+ for base in $$list; do \
+ case $$base in \
+ $(srcdir)/*) base=`echo "$$base" | sed "s|^$$srcdirstrip/||"`;; \
+ esac; \
+ if test -f $$base; then d=.; else d=$(srcdir); fi; \
+ for file in $$d/$$base*; do \
+ relfile=`expr "$$file" : "$$d/\(.*\)"`; \
+ test -f $(distdir)/$$relfile || \
+ cp -p $$file $(distdir)/$$relfile; \
+ done; \
+ done
+
+mostlyclean-aminfo:
+ -rm -rf bwmtools.aux bwmtools.cp bwmtools.cps bwmtools.fn bwmtools.fns \
+ bwmtools.ky bwmtools.kys bwmtools.log bwmtools.pg \
+ bwmtools.tmp bwmtools.toc bwmtools.tp bwmtools.tps \
+ bwmtools.vr bwmtools.vrs bwmtools.dvi bwmtools.pdf \
+ bwmtools.ps bwmtools.html
+
+maintainer-clean-aminfo:
+ @list='$(INFO_DEPS)'; for i in $$list; do \
+ i_i=`echo "$$i" | sed 's|\.info$$||;s|$$|.i|'`; \
+ echo " rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]"; \
+ rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]; \
+ done
+tags: TAGS
+TAGS:
+
+ctags: CTAGS
+CTAGS:
+
+
+distdir: $(DISTFILES)
+ @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \
+ topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \
+ list='$(DISTFILES)'; for file in $$list; do \
+ case $$file in \
+ $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \
+ $(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \
+ esac; \
+ if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \
+ dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \
+ if test "$$dir" != "$$file" && test "$$dir" != "."; then \
+ dir="/$$dir"; \
+ $(mkdir_p) "$(distdir)$$dir"; \
+ else \
+ dir=''; \
+ fi; \
+ if test -d $$d/$$file; then \
+ if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \
+ cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \
+ fi; \
+ cp -pR $$d/$$file $(distdir)$$dir || exit 1; \
+ else \
+ test -f $(distdir)/$$file \
+ || cp -p $$d/$$file $(distdir)/$$file \
+ || exit 1; \
+ fi; \
+ done
+ $(MAKE) $(AM_MAKEFLAGS) \
+ top_distdir="$(top_distdir)" distdir="$(distdir)" \
+ dist-info
+check-am: all-am
+check: check-am
+all-am: Makefile $(INFO_DEPS)
+installdirs:
+ for dir in "$(DESTDIR)$(infodir)"; do \
+ test -z "$$dir" || $(mkdir_p) "$$dir"; \
+ done
+install: install-am
+install-exec: install-exec-am
+install-data: install-data-am
+uninstall: uninstall-am
+
+install-am: all-am
+ @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am
+
+installcheck: installcheck-am
+install-strip:
+ $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
+ install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
+ `test -z '$(STRIP)' || \
+ echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install
+mostlyclean-generic:
+
+clean-generic:
+
+distclean-generic:
+ -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES)
+
+maintainer-clean-generic:
+ @echo "This command is intended for maintainers to use"
+ @echo "it deletes files that may require special tools to rebuild."
+clean: clean-am
+
+clean-am: clean-generic clean-libtool mostlyclean-am
+
+distclean: distclean-am
+ -rm -f Makefile
+distclean-am: clean-am distclean-generic distclean-libtool
+
+dvi: dvi-am
+
+dvi-am: $(DVIS)
+
+html: html-am
+
+html-am: $(HTMLS)
+
+info: info-am
+
+info-am: $(INFO_DEPS)
+
+install-data-am: install-info-am
+
+install-exec-am:
+
+install-info: install-info-am
+
+install-info-am: $(INFO_DEPS)
+ @$(NORMAL_INSTALL)
+ test -z "$(infodir)" || $(mkdir_p) "$(DESTDIR)$(infodir)"
+ @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \
+ list='$(INFO_DEPS)'; \
+ for file in $$list; do \
+ case $$file in \
+ $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \
+ esac; \
+ if test -f $$file; then d=.; else d=$(srcdir); fi; \
+ file_i=`echo "$$file" | sed 's|\.info$$||;s|$$|.i|'`; \
+ for ifile in $$d/$$file $$d/$$file-[0-9] $$d/$$file-[0-9][0-9] \
+ $$d/$$file_i[0-9] $$d/$$file_i[0-9][0-9] ; do \
+ if test -f $$ifile; then \
+ relfile=`echo "$$ifile" | sed 's|^.*/||'`; \
+ echo " $(INSTALL_DATA) '$$ifile' '$(DESTDIR)$(infodir)/$$relfile'"; \
+ $(INSTALL_DATA) "$$ifile" "$(DESTDIR)$(infodir)/$$relfile"; \
+ else : ; fi; \
+ done; \
+ done
+ @$(POST_INSTALL)
+ @if (install-info --version && \
+ install-info --version 2>&1 | sed 1q | grep -i -v debian) >/dev/null 2>&1; then \
+ list='$(INFO_DEPS)'; \
+ for file in $$list; do \
+ relfile=`echo "$$file" | sed 's|^.*/||'`; \
+ echo " install-info --info-dir='$(DESTDIR)$(infodir)' '$(DESTDIR)$(infodir)/$$relfile'";\
+ install-info --info-dir="$(DESTDIR)$(infodir)" "$(DESTDIR)$(infodir)/$$relfile" || :;\
+ done; \
+ else : ; fi
+install-man:
+
+installcheck-am:
+
+maintainer-clean: maintainer-clean-am
+ -rm -f Makefile
+maintainer-clean-am: distclean-am maintainer-clean-aminfo \
+ maintainer-clean-generic maintainer-clean-vti
+
+mostlyclean: mostlyclean-am
+
+mostlyclean-am: mostlyclean-aminfo mostlyclean-generic \
+ mostlyclean-libtool mostlyclean-vti
+
+pdf: pdf-am
+
+pdf-am: $(PDFS)
+
+ps: ps-am
+
+ps-am: $(PSS)
+
+uninstall-am: uninstall-info-am
+
+.PHONY: all all-am check check-am clean clean-generic clean-libtool \
+ dist-info distclean distclean-generic distclean-libtool \
+ distdir dvi dvi-am html html-am info info-am install \
+ install-am install-data install-data-am install-exec \
+ install-exec-am install-info install-info-am install-man \
+ install-strip installcheck installcheck-am installdirs \
+ maintainer-clean maintainer-clean-aminfo \
+ maintainer-clean-generic maintainer-clean-vti mostlyclean \
+ mostlyclean-aminfo mostlyclean-generic mostlyclean-libtool \
+ mostlyclean-vti pdf pdf-am ps ps-am uninstall uninstall-am \
+ uninstall-info-am
+
+# Tell versions [3.59,3.63) of GNU make to not export all variables.
+# Otherwise a system limit (for SysV at least) may be exceeded.
+.NOEXPORT:
Added: trunk/doc/bwmtools.info
===================================================================
--- trunk/doc/bwmtools.info 2005-01-09 16:23:48 UTC (rev 33)
+++ trunk/doc/bwmtools.info 2005-01-10 12:00:08 UTC (rev 34)
@@ -0,0 +1,852 @@
+This is bwmtools.info, produced by makeinfo version 4.7 from
+bwmtools.texi.
+
+ This manual is for BWM Tools (version devel, 7 January 2005)
+
+ Copyright (C) 2005 Linux Based Systems Design.
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.2 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+
+INFO-DIR-SECTION Network applications
+START-INFO-DIR-ENTRY
+* BWM Tools: Managing bandwidth with BWM Tools
+END-INFO-DIR-ENTRY
+
+
+File: bwmtools.info, Node: Top, Next: Introduction, Up: (dir)
+
+Bandwidth Management Tools
+**************************
+
+* Menu:
+
+* Introduction::The purpose of BWM Tools
+* Installation::Building and installing the package
+* Configuration::Configuring BWM Tools
+* Graphing::Generating graphs
+* Examples::Configuration examples
+* Advanced::Advanced issues
+* Copying This Manual::
+* Index::
+
+
+File: bwmtools.info, Node: Introduction, Next: Installation, Prev: Top, Up: Top
+
+1 Introduction
+**************
+
+Bandwidth Management Tools was designed to provide a full suite of
+bandwidth management applications, able to shape, log and graph traffic.
+
+ Seeing as BWM Tools uses iptables for matching traffic, the
+complexity of traffic control is limitless.
+
+ BWM Tools is a set of userspace utilities, no kernel patches are
+required. As long as your iptables supports the `-j QUEUE' target,
+traffic shaping will work.
+
+
+File: bwmtools.info, Node: Installation, Next: Configuration, Prev: Introduction, Up: Top
+
+2 Installation
+**************
+
+Before you can use BWM Tools, you must make sure you have all the
+dependencies installed...
+
+ * glib2 >= 2.4.0
+
+ * libxml2 >= 2.6.0
+
+ * rrdtool >= 1.0.49 (only required for graphing)
+
+ Next you need to download BWM Tools, compile it and install it.
+
+ Here is step-by-step instructions on how to do this...
+
+ 1. Download the latest version of BWM Tools, the latest version can be
+ found on the project homepage: `http://bwm-tools.lbsd.net'
+
+ 2. Uncompress the archive using either `tar jxvf <archive
+ name>.tar.bz2' or `tar zxvf <archive name>.tar.gz' depending
+ weather its a .tar.bz2 or .tar.gz respectively.
+
+ 3. Run `./configure' in the source directory. Optionally a
+ `--prefix=...' parameter can be passed which will determine where
+ BWM Tools will be installed.
+
+ 4. Once the configure process is complete, issue a `make' command,
+ this will compile BWM Tools.
+
+ 5. When BWM Tools has finished compiling, type `make install'. This
+ will by default install BWM Tools into /usr/local, unless of course
+ if you specified a `--prefix=...' above.
+
+
+File: bwmtools.info, Node: Configuration, Next: Graphing, Prev: Installation, Up: Top
+
+3 Configuration
+***************
+
+Configuration of BWM Tools is done via an XML configuration file, this
+file is normally located in /etc/bwm_tools/firewall.xml
+
+ The layout of the file is pretty simple and is split up into various
+sections, these are detailed below...
+
+* Menu:
+
+* Global::
+* ACL::
+* NAT::
+* Traffic::
+
+
+File: bwmtools.info, Node: Global, Next: ACL, Up: Configuration
+
+3.1 The `<global>' section
+==========================
+
+This section contains global directives pertaining to either the
+operation of BWM Tools or definitions used in other sections. These
+directives are detailed below...
+
+ * Module management in the `<modules>' section
+ This section is used to load modules when bwmd starts. The syntax
+ to load a module is as follows...
+ <load name="kernel_module_name" />
+
+ The `<load />' tag takes the following parameters...
+ * `name="..."' - This is the name of the module to load
+
+ * `params="..."' - Parameters to load module with
+
+ Here is how it can be used to load the ip_queue kernel module
+ required by bwmd for shaping. Including ftp connection tracking to
+ allow users to ftp through a tightly secured firewall.
+ <firewall>
+ <global>
+ <modules>
+ <load name="ip_queue"/>
+ <load name="ip_nat_ftp"/>
+ <load name="ip_conntrack_ftp"/>
+ </modules>
+ </global>
+ .
+ .
+ .
+ </firewall>
+
+ * Class definition in the `<class>' section
+ This section is used to define classes used in both firewalling
+ and network address translation. The basic syntax is as follows...
+ <class name="traffic_from_support">
+ <address name="pete_in" src="192.168.0.100" />
+ </class>
+
+ The `<class>' tag has got no other options apart from name.
+
+ The `<address />' tag on the other hand has the following
+ options...
+
+ * `name="..."' - This is a descriptive name for the address,
+ isn't really used anywhere
+
+ * `cmd-line="..."' - Optional command line arguments for
+ iptables, for example `cmd-line="-m helper --helper <string>"'
+
+ * `dst="..."' - Optional destination IP address
+
+ * `dst-iface="..."' - Optional destination interface
+
+ * `dst-port="..."' - Optional destination port
+
+ * `proto="..."' - Optional protocol specification, any valid
+ protocol in `/etc/protocols'
+
+ * `src="..."' - Optional source IP address
+
+ * `src-iface="..."' - Optional source interface
+
+ * `src-port="..."' - Optional source port
+
+ Here is an example how it can be used to match connections over a
+ specific number...
+ <firewall>
+ <global>
+ .
+ .
+ .
+ <class name="excess_connections_to_webserver">
+ <address name="excess_to_server1" dst="192.168.0.100" proto="tcp" dst-port="80" cmd-line="-m connlimit --connlimit-above 10"/>
+ </class>
+ </global>
+ .
+ .
+ .
+ </firewall>
+
+
+File: bwmtools.info, Node: ACL, Next: NAT, Prev: Global, Up: Configuration
+
+3.2 The `<acl>' section
+=======================
+
+This is basically the firewall section, you can add all your firewall
+rules here or just leave it blank to use your current firewall.
+
+ The syntax for this section is a little more complex and is as
+follows...
+ <acl>
+ <table name="filter">
+ <chain name="INPUT" defualt="ACCEPT">
+ <rule name="excess_connections" target="DROP">
+ excess_connections_to_webserver
+ </rule>
+ </chain>
+ </table>
+ </acl>
+
+ Explaining the above example, this will add 1 rule to the `INPUT'
+chain under the `filter' table which will drop all new packets that
+arrive if the concurrent connections on port 80 is higher than 10.
+
+ It is the equivalent to...
+`iptables -t filter -A INPUT -d 192.168.0.10 -p tcp -dport 80 -m
+connlimit --connlimit-above 10 -j DROP'
+
+ The following tags and parameters are available...
+ * Specify the table with `<table> ... </table>'
+ The `<table>' tag is used to enclose the directives you plan to
+ use with a specific table. Examples of tables are... `filter',
+ `nat', `mangle'
+
+ The `<table>' tag takes the following parameters...
+ * `name="..."' - This is the name of the table we will be
+ working with
+
+ * Specify a chain with `<chain> ... </chain>'
+ The `<chain>' tag is used to specify what chain the rules defined
+ between the starting and ending tags apply to. Examples of already
+ defined chains are `INPUT', `OUTPUT' and `FORWARD'.
+
+ The `<chain>' tag takes the following parameters...
+ * `name="..."' - This is the name of the chain we will be
+ working with
+
+ * `default="..."' - This specifies the default target for the
+ chain
+
+ * Specify a rule with `<rule> ... </rule>'
+ The `<rule>' tag is used to specify what classes apply to what
+ rule, and are in order inserted into the actual iptables chains as
+ iptables rules.
+
+ The `<rule>' tag takes the following parameters...
+ * `name="..."' - Optional name of rule
+
+ * `cmd-line="..."' - Optional extra command line parameters to
+ pass to iptables
+
+ * `target="..."' - This is the target for the rule, used as the
+ `-j <target>' parameter when generating iptables rules.
+
+ Between the opening and closing tags, classes defined in the
+ `<global>' section are listed, these classify which traffic
+ applies to which rule.
+
+ Multiple classes can be listed, one per line.
+
+Using the above, here is an example of a simple firewall which allows
+http and ssh traffic, assuming your IP address is 10.0.0.2 of course...
+ <firewall>
+ # Global configuration and access classes
+ <global>
+ <class name="http_traffic">
+ <address dst="10.0.0.2" proto="tcp" dst-port="80"/>
+ </class>
+ <class name="ssh_traffic">
+ <address dst="10.0.0.2" proto="tcp" dst-port="22"/>
+ </class>
+ </global>
+
+ # Access control lists
+ <acl>
+ <table name="filter">
+ <chain name="INPUT" default="DROP">
+ <rule name="allowed_traffic" target="ACCEPT">
+ http_traffic
+ ssh_traffic
+ </rule>
+ </chain>
+ <chain name="FORWARD" default="DROP">
+ </chain>
+ <chain name="OUTPUT" default="ACCEPT">
+ </chain>
+ </table>
+ </acl>
+
+ </firewall>
+
+
+File: bwmtools.info, Node: NAT, Next: Traffic, Prev: ACL, Up: Configuration
+
+3.3 The `<nat>' section
+=======================
+
+The NAT section is used to define network address translation rules,
+these rules allow one to translate the source or destination IP address
+within packets. A common use for this is when a webserver is behind a
+firewall, requests are made to a globally routable IP address and
+translated to the internal IP address of the webserver and visa versa.
+
+ This section has the following syntax...
+ <nat>
+ <snat>
+ <rule name="traf_from_webserver" to-src="<globally routable IP here>">
+ traffic_from_webserver
+ </rule>
+ </snat>
+ <dnat>
+ <rule name="traf_to_webserver" to-dst="192.168.1.100">
+ traffic_to_webserver
+ </rule>
+ </dnat>
+ </nat>
+
+ There are 2 tags available, `<snat>' and `<dnat>', these two tags
+are used for soure network address translation and destination address
+translation respectively.
+
+ Valid options for these 2 directives are as follows...
+ * Source network address translation using `<snat>'
+ SNAT is used for source network address translation, an example of
+ which is again a webserver behind a firewall. Where SNAT comes in
+ handy is when the webserver makes a query through the firewall,
+ instead of the traffic on the internet comming from the webservers
+ internal IP 192.168.1.100 which is not going to work, the firewall
+ translates 192.168.1.100 to a globally routable IP address.
+
+ There are no parameters for this directive, although the following
+ tags and parameters are available...
+ * Specify a rule with `<rule> ... </rule>'
+ The `<rule>' tag is used to specify what classes apply to
+ what rule, and are in order inserted into the actual iptables
+ chains as iptables rules.
+
+ The `<rule>' tag takes the following parameters...
+ * `name="..."' - Optional name of rule
+
+ * `to-src"..."' - Translate all traffic matched in the
+ class specification to this IP address.
+
+ Between the opening and closing tags, classes defined in the
+ `<global>' section are listed, these classify which traffic
+ applies to which rule.
+
+ Multiple classes can be listed, one per line.
+
+
+
+File: bwmtools.info, Node: Traffic, Prev: NAT, Up: Configuration
+
+3.4 The `<traffic>' section
+===========================
+
+
+File: bwmtools.info, Node: Graphing, Next: Examples, Prev: Configuration, Up: Top
+
+4 Graphing
+**********
+
+
+File: bwmtools.info, Node: Examples, Next: Advanced, Prev: Graphing, Up: Top
+
+5 Examples
+**********
+
+
+File: bwmtools.info, Node: Advanced, Next: Copying This Manual, Prev: Examples, Up: Top
+
+6 Advanced
+**********
+
+
+File: bwmtools.info, Node: Copying This Manual, Next: Index, Prev: Advanced, Up: Top
+
+Appendix A Copying This Manual
+******************************
+
+* Menu:
+
+* GNU Free Documentation License:: License for copying this manual.
+
+
+File: bwmtools.info, Node: GNU Free Documentation License, Up: Copying This Manual
+
+A.1 GNU Free Documentation License
+==================================
+
+ Version 1.2, November 2002
+
+ Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ 0. PREAMBLE
+
+ The purpose of this License is to make a manual, textbook, or other
+ functional and useful document "free" in the sense of freedom: to
+ assure everyone the effective freedom to copy and redistribute it,
+ with or without modifying it, either commercially or
+ noncommercially. Secondarily, this License preserves for the
+ author and publisher a way to get credit for their work, while not
+ being considered responsible for modifications made by others.
+
+ This License is a kind of "copyleft", which means that derivative
+ works of the document must themselves be free in the same sense.
+ It complements the GNU General Public License, which is a copyleft
+ license designed for free software.
+
+ We have designed this License in order to use it for manuals for
+ free software, because free software needs free documentation: a
+ free program should come with manuals providing the same freedoms
+ that the software does. But this License is not limited to
+ software manuals; it can be used for any textual work, regardless
+ of subject matter or whether it is published as a printed book.
+ We recommend this License principally for works whose purpose is
+ instruction or reference.
+
+ 1. APPLICABILITY AND DEFINITIONS
+
+ This License applies to any manual or other work, in any medium,
+ that contains a notice placed by the copyright holder saying it
+ can be distributed under the terms of this License. Such a notice
+ grants a world-wide, royalty-free license, unlimited in duration,
+ to use that work under the conditions stated herein. The
+ "Document", below, refers to any such manual or work. Any member
+ of the public is a licensee, and is addressed as "you". You
+ accept the license if you copy, modify or distribute the work in a
+ way requiring permission under copyright law.
+
+ A "Modified Version" of the Document means any work containing the
+ Document or a portion of it, either copied verbatim, or with
+ modifications and/or translated into another language.
+
+ A "Secondary Section" is a named appendix or a front-matter section
+ of the Document that deals exclusively with the relationship of the
+ publishers or authors of the Document to the Document's overall
+ subject (or to related matters) and contains nothing that could
+ fall directly within that overall subject. (Thus, if the Document
+ is in part a textbook of mathematics, a Secondary Section may not
+ explain any mathematics.) The relationship could be a matter of
+ historical connection with the subject or with related matters, or
+ of legal, commercial, philosophical, ethical or political position
+ regarding them.
+
+ The "Invariant Sections" are certain Secondary Sections whose
+ titles are designated, as being those of Invariant Sections, in
+ the notice that says that the Document is released under this
+ License. If a section does not fit the above definition of
+ Secondary then it is not allowed to be designated as Invariant.
+ The Document may contain zero Invariant Sections. If the Document
+ does not identify any Invariant Sections then there are none.
+
+ The "Cover Texts" are certain short passages of text that are
+ listed, as Front-Cover Texts or Back-Cover Texts, in the notice
+ that says that the Document is released under this License. A
+ Front-Cover Text may be at most 5 words, and a Back-Cover Text may
+ be at most 25 words.
+
+ A "Transparent" copy of the Document means a machine-readable copy,
+ represented in a format whose specification is available to the
+ general public, that is suitable for revising the document
+ straightforwardly with generic text editors or (for images
+ composed of pixels) generic paint programs or (for drawings) some
+ widely available drawing editor, and that is suitable for input to
+ text formatters or for automatic translation to a variety of
+ formats suitable for input to text formatters. A copy made in an
+ otherwise Transparent file format whose markup, or absence of
+ markup, has been arranged to thwart or discourage subsequent
+ modification by readers is not Transparent. An image format is
+ not Transparent if used for any substantial amount of text. A
+ copy that is not "Transparent" is called "Opaque".
+
+ Examples of suitable formats for Transparent copies include plain
+ ASCII without markup, Texinfo input format, LaTeX input format,
+ SGML or XML using a publicly available DTD, and
+ standard-conforming simple HTML, PostScript or PDF designed for
+ human modification. Examples of transparent image formats include
+ PNG, XCF and JPG. Opaque formats include proprietary formats that
+ can be read and edited only by proprietary word processors, SGML or
+ XML for which the DTD and/or processing tools are not generally
+ available, and the machine-generated HTML, PostScript or PDF
+ produced by some word processors for output purposes only.
+
+ The "Title Page" means, for a printed book, the title page itself,
+ plus such following pages as are needed to hold, legibly, the
+ material this License requires to appear in the title page. For
+ works in formats which do not have any title page as such, "Title
+ Page" means the text near the most prominent appearance of the
+ work's title, preceding the beginning of the body of the text.
+
+ A section "Entitled XYZ" means a named subunit of the Document
+ whose title either is precisely XYZ or contains XYZ in parentheses
+ following text that translates XYZ in another language. (Here XYZ
+ stands for a specific section name mentioned below, such as
+ "Acknowledgements", "Dedications", "Endorsements", or "History".)
+ To "Preserve the Title" of such a section when you modify the
+ Document means that it remains a section "Entitled XYZ" according
+ to this definition.
+
+ The Document may include Warranty Disclaimers next to the notice
+ which states that this License applies to the Document. These
+ Warranty Disclaimers are considered to be included by reference in
+ this License, but only as regards disclaiming warranties: any other
+ implication that these Warranty Disclaimers may have is void and
+ has no effect on the meaning of this License.
+
+ 2. VERBATIM COPYING
+
+ You may copy and distribute the Document in any medium, either
+ commercially or noncommercially, provided that this License, the
+ copyright notices, and the license notice saying this License
+ applies to the Document are reproduced in all copies, and that you
+ add no other conditions whatsoever to those of this License. You
+ may not use technical measures to obstruct or control the reading
+ or further copying of the copies you make or distribute. However,
+ you may accept compensation in exchange for copies. If you
+ distribute a large enough number of copies you must also follow
+ the conditions in section 3.
+
+ You may also lend copies, under the same conditions stated above,
+ and you may publicly display copies.
+
+ 3. COPYING IN QUANTITY
+
+ If you publish printed copies (or copies in media that commonly
+ have printed covers) of the Document, numbering more than 100, and
+ the Document's license notice requires Cover Texts, you must
+ enclose the copies in covers that carry, clearly and legibly, all
+ these Cover Texts: Front-Cover Texts on the front cover, and
+ Back-Cover Texts on the back cover. Both covers must also clearly
+ and legibly identify you as the publisher of these copies. The
+ front cover must present the full title with all words of the
+ title equally prominent and visible. You may add other material
+ on the covers in addition. Copying with changes limited to the
+ covers, as long as they preserve the title of the Document and
+ satisfy these conditions, can be treated as verbatim copying in
+ other respects.
+
+ If the required texts for either cover are too voluminous to fit
+ legibly, you should put the first ones listed (as many as fit
+ reasonably) on the actual cover, and continue the rest onto
+ adjacent pages.
+
+ If you publish or distribute Opaque copies of the Document
+ numbering more than 100, you must either include a
+ machine-readable Transparent copy along with each Opaque copy, or
+ state in or with each Opaque copy a computer-network location from
+ which the general network-using public has access to download
+ using public-standard network protocols a complete Transparent
+ copy of the Document, free of added material. If you use the
+ latter option, you must take reasonably prudent steps, when you
+ begin distribution of Opaque copies in quantity, to ensure that
+ this Transparent copy will remain thus accessible at the stated
+ location until at least one year after the last time you
+ distribute an Opaque copy (directly or through your agents or
+ retailers) of that edition to the public.
+
+ It is requested, but not required, that you contact the authors of
+ the Document well before redistributing any large number of
+ copies, to give them a chance to provide you with an updated
+ version of the Document.
+
+ 4. MODIFICATIONS
+
+ You may copy and distribute a Modified Version of the Document
+ under the conditions of sections 2 and 3 above, provided that you
+ release the Modified Version under precisely this License, with
+ the Modified Version filling the role of the Document, thus
+ licensing distribution and modification of the Modified Version to
+ whoever possesses a copy of it. In addition, you must do these
+ things in the Modified Version:
+
+ A. Use in the Title Page (and on the covers, if any) a title
+ distinct from that of the Document, and from those of
+ previous versions (which should, if there were any, be listed
+ in the History section of the Document). You may use the
+ same title as a previous version if the original publisher of
+ that version gives permission.
+
+ B. List on the Title Page, as authors, one or more persons or
+ entities responsible for authorship of the modifications in
+ the Modified Version, together with at least five of the
+ principal authors of the Document (all of its principal
+ authors, if it has fewer than five), unless they release you
+ from this requirement.
+
+ C. State on the Title page the name of the publisher of the
+ Modified Version, as the publisher.
+
+ D. Preserve all the copyright notices of the Document.
+
+ E. Add an appropriate copyright notice for your modifications
+ adjacent to the other copyright notices.
+
+ F. Include, immediately after the copyright notices, a license
+ notice giving the public permission to use the Modified
+ Version under the terms of this License, in the form shown in
+ the Addendum below.
+
+ G. Preserve in that license notice the full lists of Invariant
+ Sections and required Cover Texts given in the Document's
+ license notice.
+
+ H. Include an unaltered copy of this License.
+
+ I. Preserve the section Entitled "History", Preserve its Title,
+ and add to it an item stating at least the title, year, new
+ authors, and publisher of the Modified Version as given on
+ the Title Page. If there is no section Entitled "History" in
+ the Document, create one stating the title, year, authors,
+ and publisher of the Document as given on its Title Page,
+ then add an item describing the Modified Version as stated in
+ the previous sentence.
+
+ J. Preserve the network location, if any, given in the Document
+ for public access to a Transparent copy of the Document, and
+ likewise the network locations given in the Document for
+ previous versions it was based on. These may be placed in
+ the "History" section. You may omit a network location for a
+ work that was published at least four years before the
+ Document itself, or if the original publisher of the version
+ it refers to gives permission.
+
+ K. For any section Entitled "Acknowledgements" or "Dedications",
+ Preserve the Title of the section, and preserve in the
+ section all the substance and tone of each of the contributor
+ acknowledgements and/or dedications given therein.
+
+ L. Preserve all the Invariant Sections of the Document,
+ unaltered in their text and in their titles. Section numbers
+ or the equivalent are not considered part of the section
+ titles.
+
+ M. Delete any section Entitled "Endorsements". Such a section
+ may not be included in the Modified Version.
+
+ N. Do not retitle any existing section to be Entitled
+ "Endorsements" or to conflict in title with any Invariant
+ Section.
+
+ O. Preserve any Warranty Disclaimers.
+
+ If the Modified Version includes new front-matter sections or
+ appendices that qualify as Secondary Sections and contain no
+ material copied from the Document, you may at your option
+ designate some or all of these sections as invariant. To do this,
+ add their titles to the list of Invariant Sections in the Modified
+ Version's license notice. These titles must be distinct from any
+ other section titles.
+
+ You may add a section Entitled "Endorsements", provided it contains
+ nothing but endorsements of your Modified Version by various
+ parties--for example, statements of peer review or that the text
+ has been approved by an organization as the authoritative
+ definition of a standard.
+
+ You may add a passage of up to five words as a Front-Cover Text,
+ and a passage of up to 25 words as a Back-Cover Text, to the end
+ of the list of Cover Texts in the Modified Version. Only one
+ passage of Front-Cover Text and one of Back-Cover Text may be
+ added by (or through arrangements made by) any one entity. If the
+ Document already includes a cover text for the same cover,
+ previously added by you or by arrangement made by the same entity
+ you are acting on behalf of, you may not add another; but you may
+ replace the old one, on explicit permission from the previous
+ publisher that added the old one.
+
+ The author(s) and publisher(s) of the Document do not by this
+ License give permission to use their names for publicity for or to
+ assert or imply endorsement of any Modified Version.
+
+ 5. COMBINING DOCUMENTS
+
+ You may combine the Document with other documents released under
+ this License, under the terms defined in section 4 above for
+ modified versions, provided that you include in the combination
+ all of the Invariant Sections of all of the original documents,
+ unmodified, and list them all as Invariant Sections of your
+ combined work in its license notice, and that you preserve all
+ their Warranty Disclaimers.
+
+ The combined work need only contain one copy of this License, and
+ multiple identical Invariant Sections may be replaced with a single
+ copy. If there are multiple Invariant Sections with the same name
+ but different contents, make the title of each such section unique
+ by adding at the end of it, in parentheses, the name of the
+ original author or publisher of that section if known, or else a
+ unique number. Make the same adjustment to the section titles in
+ the list of Invariant Sections in the license notice of the
+ combined work.
+
+ In the combination, you must combine any sections Entitled
+ "History" in the various original documents, forming one section
+ Entitled "History"; likewise combine any sections Entitled
+ "Acknowledgements", and any sections Entitled "Dedications". You
+ must delete all sections Entitled "Endorsements."
+
+ 6. COLLECTIONS OF DOCUMENTS
+
+ You may make a collection consisting of the Document and other
+ documents released under this License, and replace the individual
+ copies of this License in the various documents with a single copy
+ that is included in the collection, provided that you follow the
+ rules of this License for verbatim copying of each of the
+ documents in all other respects.
+
+ You may extract a single document from such a collection, and
+ distribute it individually under this License, provided you insert
+ a copy of this License into the extracted document, and follow
+ this License in all other respects regarding verbatim copying of
+ that document.
+
+ 7. AGGREGATION WITH INDEPENDENT WORKS
+
+ A compilation of the Document or its derivatives with other
+ separate and independent documents or works, in or on a volume of
+ a storage or distribution medium, is called an "aggregate" if the
+ copyright resulting from the compilation is not used to limit the
+ legal rights of the compilation's users beyond what the individual
+ works permit. When the Document is included in an aggregate, this
+ License does not apply to the other works in the aggregate which
+ are not themselves derivative works of the Document.
+
+ If the Cover Text requirement of section 3 is applicable to these
+ copies of the Document, then if the Document is less than one half
+ of the entire aggregate, the Document's Cover Texts may be placed
+ on covers that bracket the Document within the aggregate, or the
+ electronic equivalent of covers if the Document is in electronic
+ form. Otherwise they must appear on printed covers that bracket
+ the whole aggregate.
+
+ 8. TRANSLATION
+
+ Translation is considered a kind of modification, so you may
+ distribute translations of the Document under the terms of section
+ 4. Replacing Invariant Sections with translations requires special
+ permission from their copyright holders, but you may include
+ translations of some or all Invariant Sections in addition to the
+ original versions of these Invariant Sections. You may include a
+ translation of this License, and all the license notices in the
+ Document, and any Warranty Disclaimers, provided that you also
+ include the original English version of this License and the
+ original versions of those notices and disclaimers. In case of a
+ disagreement between the translation and the original version of
+ this License or a notice or disclaimer, the original version will
+ prevail.
+
+ If a section in the Document is Entitled "Acknowledgements",
+ "Dedications", or "History", the requirement (section 4) to
+ Preserve its Title (section 1) will typically require changing the
+ actual title.
+
+ 9. TERMINATION
+
+ You may not copy, modify, sublicense, or distribute the Document
+ except as expressly provided for under this License. Any other
+ attempt to copy, modify, sublicense or distribute the Document is
+ void, and will automatically terminate your rights under this
+ License. However, parties who have received copies, or rights,
+ from you under this License will not have their licenses
+ terminated so long as such parties remain in full compliance.
+
+ 10. FUTURE REVISIONS OF THIS LICENSE
+
+ The Free Software Foundation may publish new, revised versions of
+ the GNU Free Documentation License from time to time. Such new
+ versions will be similar in spirit to the present version, but may
+ differ in detail to address new problems or concerns. See
+ `http://www.gnu.org/copyleft/'.
+
+ Each version of the License is given a distinguishing version
+ number. If the Document specifies that a particular numbered
+ version of this License "or any later version" applies to it, you
+ have the option of following the terms and conditions either of
+ that specified version or of any later version that has been
+ published (not as a draft) by the Free Software Foundation. If
+ the Document does not specify a version number of this License,
+ you may choose any version ever published (not as a draft) by the
+ Free Software Foundation.
+
+A.1.1 ADDENDUM: How to use this License for your documents
+----------------------------------------------------------
+
+To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and license
+notices just after the title page:
+
+ Copyright (C) YEAR YOUR NAME.
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.2
+ or any later version published by the Free Software Foundation;
+ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+ Texts. A copy of the license is included in the section entitled ``GNU
+ Free Documentation License''.
+
+ If you have Invariant Sections, Front-Cover Texts and Back-Cover
+Texts, replace the "with...Texts." line with this:
+
+ with the Invariant Sections being LIST THEIR TITLES, with
+ the Front-Cover Texts being LIST, and with the Back-Cover Texts
+ being LIST.
+
+ If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+ If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License, to
+permit their use in free software.
+
+
+File: bwmtools.info, Node: Index, Prev: Copying This Manual, Up: Top
+
+Index
+*****
+
+
+* Menu:
+
+* FDL, GNU Free Documentation License: GNU Free Documentation License.
+ (line 6)
+* introduction: Introduction. (line 6)
+
+
+
+Tag Table:
+Node: Top719
+Node: Introduction1111
+Node: Installation1642
+Node: Configuration2868
+Node: Global3282
+Node: ACL6078
+Node: NAT9550
+Node: Traffic11910
+Node: Graphing12038
+Node: Examples12150
+Node: Advanced12257
+Node: Copying This Manual12375
+Node: GNU Free Documentation License12609
+Node: Index35020
+
+End Tag Table
Added: trunk/doc/bwmtools.texi
===================================================================
--- trunk/doc/bwmtools.texi 2005-01-09 16:23:48 UTC (rev 33)
+++ trunk/doc/bwmtools.texi 2005-01-10 12:00:08 UTC (rev 34)
@@ -0,0 +1,1647 @@
+\input texinfo @c -*-texinfo-*-
+@comment %**start of header
+@setfilename bwmtools.info
+@include version.texi
+@settitle bwmtools
+@setchapternewpage on
+@setcontentsaftertitlepage
+@firstparagraphindent none
+@syncodeindex pg cp
+@comment %**end of header
+
+
+@copying
+This manual is for BWM Tools
+(version @value{VERSION}, @value{UPDATED})
+
+Copyright @copyright{} 2005 Linux Based Systems Design.
+
+@quotation
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2
+or any later version published by the Free Software Foundation;
+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+Texts. A copy of the license is included in the section entitled ``GNU
+Free Documentation License''.
+@end quotation
+@end copying
+
+
+@dircategory Network applications
+@direntry
+* BWM Tools: Managing bandwidth with BWM Tools
+@end direntry
+
+
+
+@titlepage
+@title Bandwidth Management Tools
+@subtitle for version @value{VERSION}, @value{UPDATED}
+@author Written by: Nigel Kukard <@email{nkukard@@lbsd.net}>
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@ifnottex
+@node Top
+@top Bandwidth Management Tools
+@end ifnottex
+
+@menu
+* Introduction::The purpose of BWM Tools
+* Installation::Building and installing the package
+* Configuration::Configuring BWM Tools
+* Integration::Integrating BWM Tools with your system
+* Graphing::Generating graphs
+* Examples::Configuration examples
+* Copying This Manual::
+* Index::
+@end menu
+
+
+
+
+
+
+
+
+@node Introduction
+@chapter Introduction to BWM Tools
+Bandwidth Management Tools was designed to provide a full suite of bandwidth
+management applications, able to shape, log and graph traffic.
+@*@*
+Seeing as BWM Tools uses iptables for matching traffic, the complexity of
+traffic control is limitless.
+@*@*
+BWM Tools is a set of userspace utilities, no kernel patches are required.
+As long as your iptables supports the @option{-j QUEUE} target, traffic
+shaping will work.
+
+
+
+
+
+
+
+@node Installation
+@chapter Installing BWM Tools
+
+Before you can use BWM Tools, you must make sure you have all the
+dependencies installed@dots{}
+@*
+@itemize
+@item
+glib2 >= 2.4.0
+@item
+libxml2 >= 2.6.0
+@item
+rrdtool >= 1.0.49 (only required for graphing)
+@end itemize
+@*
+Next you need to download BWM Tools, compile it and install
+it.
+@*@*
+Here is step-by-step instructions on how to do this@dots{}
+@*
+@enumerate
+@item
+Download the latest version of BWM Tools, the latest version can be
+found on the project homepage: @url{http://bwm-tools.lbsd.net}
+@*
+@item
+Uncompress the archive using either @code{tar jxvf <archive name>.tar.bz2}
+or @code{tar zxvf <archive name>.tar.gz} depending weather its a .tar.bz2
+or .tar.gz respectively.
+@*
+@item
+Run @command{./configure} in the source directory. Optionally a
+@option{--prefix=@dots{}} parameter can be passed which will determine where
+BWM Tools will be installed.
+@*
+@item
+Once the configure process is complete, issue a @command{make} command,
+this will compile BWM Tools.
+@*
+@item
+When BWM Tools has finished compiling, type @code{make install}. This
+will by default install BWM Tools into /usr/local, unless of course
+if you specified a @option{--prefix=@dots{}} above.
+@end enumerate
+
+
+
+
+
+
+
+
+
+
+@node Configuration
+@chapter Configuring BWM Tools
+
+Configuration of BWM Tools is done via an XML configuration file, this file
+is normally located in /etc/bwm_tools/firewall.xml
+@*@*
+The layout of the file is pretty simple and is split up into various sections,
+these are detailed in the following sections@dots{}
+
+
+@menu
+* Global::Global options and class definitions
+* ACL::Access control lists / firewalling
+* NAT::Network Address Translation
+* Traffic::Traffic shaping
+@end menu
+
+
+
+
+
+
+@node Global
+@section The @code{<global>} section
+@cindex global
+This section contains global tags pertaining to either the operation of BWM
+Tools or definitions used in other sections. These tags are detailed
+below@dots{}
+@*
+@itemize
+@item
+@cindex modules
+Module management in the @code{<modules>} section
+@*@*
+This section is used to load modules when bwmd starts. The syntax to load
+a module is as follows@dots{}
+@*
+@smallexample
+ <load name="kernel_module_name" />
+@end smallexample
+@*
+The @code{<load />} tag takes the following parameters@dots{}
+@*
+@cindex load
+@itemize
+@item
+@code{name="@dots{}"} - This is the name of the module to load
+@item
+@code{params="@dots{}"} - Parameters to load module with
+@end itemize
+@*
+Here is how it can be used to load the ip_queue kernel module required
+by bwmd for shaping. Including ftp connection tracking to allow users to
+ftp through a tightly secured firewall.
+@*
+@smallexample
+<firewall>
+ <global>
+ <modules>
+ <load name="ip_queue"/>
+ <load name="ip_nat_ftp"/>
+ <load name="ip_conntrack_ftp"/>
+ </modules>
+ </global>
+.
+.
+.
+</firewall>
+@end smallexample
+
+@*
+@item
+@cindex class
+Class definition in the @code{<class>} section
+@*@*
+This section is used to define classes used in both firewalling and network
+address translation. The basic syntax is as follows@dots{}
+@*
+@smallexample
+ <class name="traffic_f...
[truncated message content] |
