diff options
author | Darrell Anderson <[email protected]> | 2014-03-02 13:51:46 -0600 |
---|---|---|
committer | Darrell Anderson <[email protected]> | 2014-03-02 13:51:46 -0600 |
commit | 7041076de6fd520c2ebda3eedce16f44b3d6551f (patch) | |
tree | 5720aa9e2fa745e00eb3df17ddf74d87329acf86 /doc/en | |
parent | 61ae82fd947ea8d33649a4bf2ff24bf691421436 (diff) | |
download | ksensors-7041076de6fd520c2ebda3eedce16f44b3d6551f.tar.gz ksensors-7041076de6fd520c2ebda3eedce16f44b3d6551f.zip |
Replace template-only help handbook with new default format and delete obsolete Makefile.in files.
Diffstat (limited to 'doc/en')
-rw-r--r-- | doc/en/Makefile.in | 512 | ||||
-rw-r--r-- | doc/en/index.docbook | 551 |
2 files changed, 31 insertions, 1032 deletions
diff --git a/doc/en/Makefile.in b/doc/en/Makefile.in deleted file mode 100644 index 448ab7f..0000000 --- a/doc/en/Makefile.in +++ /dev/null @@ -1,512 +0,0 @@ -# Makefile.in generated by automake 1.6.3 from Makefile.am. -# KDE tags expanded automatically by am_edit - $Revision: 1.5 $ -# @configure_input@ - -# Copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 -# 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@ -SHELL = @SHELL@ - -srcdir = @srcdir@ -top_srcdir = @top_srcdir@ -VPATH = @srcdir@ -prefix = @prefix@ -exec_prefix = @exec_prefix@ - -bindir = @bindir@ -sbindir = @sbindir@ -libexecdir = @libexecdir@ -datadir = @datadir@ -sysconfdir = @sysconfdir@ -sharedstatedir = @sharedstatedir@ -localstatedir = @localstatedir@ -libdir = @libdir@ -infodir = @infodir@ -mandir = @mandir@ -includedir = @includedir@ -oldincludedir = /usr/include -pkgdatadir = $(datadir)/@PACKAGE@ -pkglibdir = $(libdir)/@PACKAGE@ -pkgincludedir = $(includedir)/@PACKAGE@ -top_builddir = ../.. - -ACLOCAL = @ACLOCAL@ -AUTOCONF = @AUTOCONF@ -AUTOMAKE = @AUTOMAKE@ -AUTOHEADER = @AUTOHEADER@ - -am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd -INSTALL = @INSTALL@ -INSTALL_PROGRAM = @INSTALL_PROGRAM@ -INSTALL_DATA = @INSTALL_DATA@ -install_sh_DATA = $(install_sh) -c -m 644 -install_sh_PROGRAM = $(install_sh) -c -install_sh_SCRIPT = $(install_sh) -c -INSTALL_SCRIPT = @INSTALL_SCRIPT@ -INSTALL_HEADER = $(INSTALL_DATA) -transform = @program_transform_name@ -NORMAL_INSTALL = : -PRE_INSTALL = : -POST_INSTALL = : -NORMAL_UNINSTALL = : -PRE_UNINSTALL = : -POST_UNINSTALL = : -build_alias = @build_alias@ -build_triplet = @build@ -host_alias = @host_alias@ -host_triplet = @host@ -target_alias = @target_alias@ -target_triplet = @target@ - -EXEEXT = @EXEEXT@ -OBJEXT = @OBJEXT@ -PATH_SEPARATOR = @PATH_SEPARATOR@ -AMTAR = @AMTAR@ -ARTSCCONFIG = @ARTSCCONFIG@ -AS = @AS@ -AUTODIRS = @AUTODIRS@ -AWK = @AWK@ -BROCKENBORING = @BROCKENBORING@ -CC = @CC@ -CONF_FILES = @CONF_FILES@ -CPP = @CPP@ -CXX = @CXX@ -CXXCPP = @CXXCPP@ -DCOPIDL = @DCOPIDL@ -DCOPIDL2CPP = @DCOPIDL2CPP@ -DCOP_DEPENDENCIES = @DCOP_DEPENDENCIES@ -DEPDIR = @DEPDIR@ -DLLTOOL = @DLLTOOL@ -DOXYGEN = @DOXYGEN@ -DOXYGEN_PROJECT_NAME = @DOXYGEN_PROJECT_NAME@ -DOXYGEN_PROJECT_NUMBER = @DOXYGEN_PROJECT_NUMBER@ -DPMSINC = @DPMSINC@ -DPMSLIB = @DPMSLIB@ -ECHO = @ECHO@ -FRAMEWORK_COREAUDIO = @FRAMEWORK_COREAUDIO@ -GCJ = @GCJ@ -GCJFLAGS = @GCJFLAGS@ -GLINC = @GLINC@ -GLLIB = @GLLIB@ -GMSGFMT = @GMSGFMT@ -IDL = @IDL@ -IDL_DEPENDENCIES = @IDL_DEPENDENCIES@ -INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ -JAR = @JAR@ -JAVAC = @JAVAC@ -JAVAH = @JAVAH@ -JVMLIBS = @JVMLIBS@ -KDECONFIG = @KDECONFIG@ -KDE_EXTRA_RPATH = @KDE_EXTRA_RPATH@ -KDE_HAS_DOXYGEN = @KDE_HAS_DOXYGEN@ -KDE_HAVE_DOT = @KDE_HAVE_DOT@ -KDE_INCLUDES = @KDE_INCLUDES@ -KDE_LDFLAGS = @KDE_LDFLAGS@ -KDE_MT_LDFLAGS = @KDE_MT_LDFLAGS@ -KDE_MT_LIBS = @KDE_MT_LIBS@ -KDE_NO_UNDEFINED = @KDE_NO_UNDEFINED@ -KDE_PLUGIN = @KDE_PLUGIN@ -KDE_RPATH = @KDE_RPATH@ -KDE_USE_CLOSURE_FALSE = @KDE_USE_CLOSURE_FALSE@ -KDE_USE_CLOSURE_TRUE = @KDE_USE_CLOSURE_TRUE@ -KDE_USE_FINAL_FALSE = @KDE_USE_FINAL_FALSE@ -KDE_USE_FINAL_TRUE = @KDE_USE_FINAL_TRUE@ -KDE_USE_NMCHECK_FALSE = @KDE_USE_NMCHECK_FALSE@ -KDE_USE_NMCHECK_TRUE = @KDE_USE_NMCHECK_TRUE@ -KDE_XSL_STYLESHEET = @KDE_XSL_STYLESHEET@ -LEX = @LEX@ -LEXLIB = @LEXLIB@ -LEX_OUTPUT_ROOT = @LEX_OUTPUT_ROOT@ -LIBBZ2 = @LIBBZ2@ -LIBCOMPAT = @LIBCOMPAT@ -LIBCRYPT = @LIBCRYPT@ -LIBDL = @LIBDL@ -LIBGEN = @LIBGEN@ -LIBJPEG = @LIBJPEG@ -LIBMICO = @LIBMICO@ -LIBOBJS = @LIBOBJS@ -LIBPNG = @LIBPNG@ -LIBPTHREAD = @LIBPTHREAD@ -LIBPYTHON = @LIBPYTHON@ -LIBQIMGIO = @LIBQIMGIO@ -LIBRESOLV = @LIBRESOLV@ -LIBSHADOW = @LIBSHADOW@ -LIBSM = @LIBSM@ -LIBSOCKET = @LIBSOCKET@ -LIBSSL = @LIBSSL@ -LIBTIFF = @LIBTIFF@ -LIBTOOL = @LIBTOOL@ -LIBUCB = @LIBUCB@ -LIBUTIL = @LIBUTIL@ -LIBZ = @LIBZ@ -LIB_JASPER = @LIB_JASPER@ -LIB_KAB = @LIB_KAB@ -LIB_KABC = @LIB_KABC@ -LIB_TDECORE = @LIB_TDECORE@ -LIB_TDEPRINT = @LIB_TDEPRINT@ -LIB_TDEUI = @LIB_TDEUI@ -LIB_KFILE = @LIB_KFILE@ -LIB_KFM = @LIB_KFM@ -LIB_TDEHTML = @LIB_TDEHTML@ -LIB_KIMGIO = @LIB_KIMGIO@ -LIB_TDEIO = @LIB_TDEIO@ -LIB_TDEPARTS = @LIB_TDEPARTS@ -LIB_TDESPELL = @LIB_TDESPELL@ -LIB_TDESYCOCA = @LIB_TDESYCOCA@ -LIB_POLL = @LIB_POLL@ -LIB_QPE = @LIB_QPE@ -LIB_QT = @LIB_QT@ -LIB_QTOPIA = @LIB_QTOPIA@ -LIB_SMB = @LIB_SMB@ -LIB_X11 = @LIB_X11@ -LIB_XEXT = @LIB_XEXT@ -LIB_XRENDER = @LIB_XRENDER@ -LN_S = @LN_S@ -MCOPIDL = @MCOPIDL@ -MEINPROC = @MEINPROC@ -MICO_INCLUDES = @MICO_INCLUDES@ -MICO_LDFLAGS = @MICO_LDFLAGS@ -MOC = @MOC@ -MSGFMT = @MSGFMT@ -NOOPT_CFLAGS = @NOOPT_CFLAGS@ -NOOPT_CXXFLAGS = @NOOPT_CXXFLAGS@ -OBJC = @OBJC@ -OBJCFLAGS = @OBJCFLAGS@ -OBJDUMP = @OBJDUMP@ -PACKAGE = @PACKAGE@ -PAMLIBS = @PAMLIBS@ -PASSWDLIBS = @PASSWDLIBS@ -PYTHONINC = @PYTHONINC@ -PYTHONLIB = @PYTHONLIB@ -PYTHONMODDIR = @PYTHONMODDIR@ -QTDOCDIR = @QTDOCDIR@ -QTE_NORTTI = @QTE_NORTTI@ -QTOPIA_INCLUDES = @QTOPIA_INCLUDES@ -QT_INCLUDES = @QT_INCLUDES@ -QT_LDFLAGS = @QT_LDFLAGS@ -RANLIB = @RANLIB@ -RC = @RC@ -SETUIDFLAGS = @SETUIDFLAGS@ -SSL_INCLUDES = @SSL_INCLUDES@ -SSL_LDFLAGS = @SSL_LDFLAGS@ -STRIP = @STRIP@ -TOPSUBDIRS = @TOPSUBDIRS@ -UIC = @UIC@ -UIC_TR = @UIC_TR@ -USER_INCLUDES = @USER_INCLUDES@ -USER_LDFLAGS = @USER_LDFLAGS@ -USE_EXCEPTIONS = @USE_EXCEPTIONS@ -USE_RTTI = @USE_RTTI@ -USE_THREADS = @USE_THREADS@ -VERSION = @VERSION@ -WOVERLOADED_VIRTUAL = @WOVERLOADED_VIRTUAL@ -XGETTEXT = @XGETTEXT@ -XPMINC = @XPMINC@ -XPMLIB = @XPMLIB@ -X_EXTRA_LIBS = @X_EXTRA_LIBS@ -X_INCLUDES = @X_INCLUDES@ -X_LDFLAGS = @X_LDFLAGS@ -X_PRE_LIBS = @X_PRE_LIBS@ -X_RPATH = @X_RPATH@ -all_includes = @all_includes@ -all_libraries = @all_libraries@ -am__include = @am__include@ -am__quote = @am__quote@ -idldir = @idldir@ -install_sh = @install_sh@ -jni_includes = @jni_includes@ -kde_appsdir = @kde_appsdir@ -kde_bindir = @kde_bindir@ -kde_confdir = @kde_confdir@ -kde_datadir = @kde_datadir@ -kde_htmldir = @kde_htmldir@ -kde_icondir = @kde_icondir@ -kde_includes = @kde_includes@ -kde_libraries = @kde_libraries@ -kde_libs_htmldir = @kde_libs_htmldir@ -kde_libs_prefix = @kde_libs_prefix@ -kde_locale = @kde_locale@ -kde_mimedir = @kde_mimedir@ -kde_moduledir = @kde_moduledir@ -kde_qtver = @kde_qtver@ -kde_servicesdir = @kde_servicesdir@ -kde_servicetypesdir = @kde_servicetypesdir@ -kde_sounddir = @kde_sounddir@ -kde_styledir = @kde_styledir@ -kde_templatesdir = @kde_templatesdir@ -kde_wallpaperdir = @kde_wallpaperdir@ -kde_widgetdir = @kde_widgetdir@ -tdeinitdir = @tdeinitdir@ -micodir = @micodir@ -qt_includes = @qt_includes@ -qt_libraries = @qt_libraries@ -x_includes = @x_includes@ -x_libraries = @x_libraries@ -xdg_appsdir = @xdg_appsdir@ -xdg_directorydir = @xdg_directorydir@ -KDE_DOCS = ksensors -KDE_LANG = en -subdir = doc/en -mkinstalldirs = $(SHELL) $(top_srcdir)/admin/mkinstalldirs -CONFIG_HEADER = $(top_builddir)/config.h -CONFIG_CLEAN_FILES = -DIST_SOURCES = -DIST_COMMON = Makefile.am Makefile.in -#>- all: all-am -#>+ 1 -all: docs-am all-am - -.SUFFIXES: -$(srcdir)/Makefile.in: Makefile.am $(top_srcdir)/configure.in $(ACLOCAL_M4) -#>- cd $(top_srcdir) && \ -#>- $(AUTOMAKE) --gnu doc/en/Makefile -#>+ 3 - cd $(top_srcdir) && \ - $(AUTOMAKE) --gnu doc/en/Makefile - cd $(top_srcdir) && perl admin/am_edit ksensors-0.7.3/doc/en/Makefile.in -Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status - cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe) - -mostlyclean-libtool: - -rm -f *.lo - -clean-libtool: - -rm -rf .libs _libs - -distclean-libtool: - -rm -f libtool -uninstall-info-am: -tags: TAGS -TAGS: - -#>- DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) -#>+ 1 -DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) $(KDE_DIST) - -top_distdir = ../.. -distdir = $(top_distdir)/$(PACKAGE)-$(VERSION) - -#>- distdir: $(DISTFILES) -#>+ 1 -distdir: distdir-nls $(DISTFILES) - @list='$(DISTFILES)'; for file in $$list; do \ - 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"; \ - $(mkinstalldirs) "$(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 -check-am: all-am -check: check-am -all-am: Makefile - -installdirs: - -install: install-am -install-exec: install-exec-am -install-data: install-data-am -#>- uninstall: uninstall-am -#>+ 1 -uninstall: uninstall-docs uninstall-nls 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_STRIP_FLAG=-s \ - `test -z '$(STRIP)' || \ - echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install -mostlyclean-generic: - -clean-generic: - -distclean-generic: - -rm -f Makefile $(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 -#>+ 1 -clean: kde-rpo-clean clean-am - -#>- clean-am: clean-generic clean-libtool mostlyclean-am -#>+ 1 -clean-am: clean-docs clean-bcheck clean-generic clean-libtool mostlyclean-am - -distclean: distclean-am - -distclean-am: clean-am distclean-generic distclean-libtool - -dvi: dvi-am - -dvi-am: - -info: info-am - -info-am: - -#>- install-data-am: -#>+ 1 -install-data-am: install-docs install-nls - -install-exec-am: - -install-info: install-info-am - -install-man: - -installcheck-am: - -maintainer-clean: maintainer-clean-am - -maintainer-clean-am: distclean-am maintainer-clean-generic - -mostlyclean: mostlyclean-am - -mostlyclean-am: mostlyclean-generic mostlyclean-libtool - -uninstall-am: uninstall-info-am - -.PHONY: all all-am check check-am clean clean-generic clean-libtool \ - distclean distclean-generic distclean-libtool distdir dvi \ - dvi-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-generic mostlyclean mostlyclean-generic \ - mostlyclean-libtool 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: - - -#>+ 2 -KDE_DIST=index.docbook index.cache.bz2 - -#>+ 24 -index.cache.bz2: $(srcdir)/index.docbook $(KDE_XSL_STYLESHEET) index.docbook - @if test -n "$(MEINPROC)"; then echo $(MEINPROC) --check --cache index.cache.bz2 $(srcdir)/index.docbook; $(MEINPROC) --check --cache index.cache.bz2 $(srcdir)/index.docbook; fi - -docs-am: index.cache.bz2 - -install-docs: docs-am install-nls - $(mkinstalldirs) $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/ksensors - @if test -f index.cache.bz2; then \ - echo $(INSTALL_DATA) index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/ksensors/; \ - $(INSTALL_DATA) index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/ksensors/; \ - elif test -f $(srcdir)/index.cache.bz2; then \ - echo $(INSTALL_DATA) $(srcdir)/index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/ksensors/; \ - $(INSTALL_DATA) $(srcdir)/index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/ksensors/; \ - fi - -rm -f $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/ksensors/common - $(LN_S) $(kde_libs_htmldir)/$(KDE_LANG)/common $(DESTDIR)$(kde_htmldir)/$(TDE_LANG)/ksensors/common - -uninstall-docs: - -rm -rf $(kde_htmldir)/$(KDE_LANG)/ksensors - -clean-docs: - -rm -f index.cache.bz2 - - -#>+ 13 -install-nls: - $(mkinstalldirs) $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/ksensors - @for base in index.docbook ; do \ - echo $(INSTALL_DATA) $$base $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/ksensors/$$base ;\ - $(INSTALL_DATA) $(srcdir)/$$base $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/ksensors/$$base ;\ - done - -uninstall-nls: - for base in index.docbook ; do \ - rm -f $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/ksensors/$$base ;\ - done - - -#>+ 5 -distdir-nls: - for file in index.docbook ; do \ - cp $(srcdir)/$$file $(distdir); \ - done - -#>+ 6 -force-reedit: - cd $(top_srcdir) && \ - $(AUTOMAKE) --gnu doc/en/Makefile - cd $(top_srcdir) && perl admin/am_edit ksensors-0.7.3/doc/en/Makefile.in - - -#>+ 21 -clean-bcheck: - rm -f *.bchecktest.cc *.bchecktest.cc.class a.out - -bcheck: bcheck-am - -bcheck-am: - @for i in ; do \ - if test $(srcdir)/$$i -nt $$i.bchecktest.cc; then \ - echo "int main() {return 0;}" > $$i.bchecktest.cc ; \ - echo "#include \"$$i\"" >> $$i.bchecktest.cc ; \ - echo "$$i"; \ - if ! $(CXX) $(DEFS) -I. -I$(srcdir) -I$(top_builddir) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(KDE_CXXFLAGS) --dump-class-hierarchy $$i.bchecktest.cc; then \ - rm -f $$i.bchecktest.cc; exit 1; \ - fi ; \ - echo "" >> $$i.bchecktest.cc.class; \ - perl $(top_srcdir)/admin/bcheck.pl $$i.bchecktest.cc.class || { rm -f $$i.bchecktest.cc; exit 1; }; \ - rm -f a.out; \ - fi ; \ - done - - -#>+ 3 -final: - $(MAKE) all-am - -#>+ 3 -final-install: - $(MAKE) install-am - -#>+ 3 -no-final: - $(MAKE) all-am - -#>+ 3 -no-final-install: - $(MAKE) install-am - -#>+ 3 -cvs-clean: - $(MAKE) admindir=$(top_srcdir)/admin -f $(top_srcdir)/admin/Makefile.common cvs-clean - -#>+ 3 -kde-rpo-clean: - -rm -f *.rpo - -#>+ 3 -nmcheck: -nmcheck-am: nmcheck diff --git a/doc/en/index.docbook b/doc/en/index.docbook index 8ac293f..a4bdebf 100644 --- a/doc/en/index.docbook +++ b/doc/en/index.docbook @@ -1,551 +1,62 @@ <?xml version="1.0" ?> -<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ - <!ENTITY ksensors "<application>ksensors</application>"> - <!ENTITY kappname "&ksensors;"><!-- Do *not* replace kappname--> - <!ENTITY package "kde-module"><!-- tdebase, tdeadmin, etc --> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY ksensors "<application>KSensors</application>"> + <!ENTITY kappname "&ksensors;"> <!ENTITY % addindex "IGNORE"> - <!ENTITY % English "INCLUDE"><!-- change language only here --> + <!ENTITY % English "INCLUDE"> ]> -<!-- kdoctemplate v0.8 October 1 1999 - Minor update to "Credits and Licenses" section on August 24, 2000 - Removed "Revision history" section on 22 January 2001 - Changed to Installation/Help menu entities 18 October 2001 - Other minor cleanup and changes 18 October 2001 --> +<article lang="&language;"> +<title>The &kappname; Handbook</title> -<!-- -This template was designed by: David Rugge [email protected] -with lots of help from: Eric Bischoff [email protected] -and Frederik Fouvry [email protected] -of the KDE DocBook team. - -You may freely use this template for writing any sort of TDE documentation. -If you have any changes or improvements, please let us know. - -Remember: -- in XML, the case of the <tags> and attributes is relevant ; -- also, quote all attributes. - -Please don't forget to remove all these comments in your final documentation, -thanks ;-). ---> - -<!-- ................................................................ --> - -<!-- The language must NOT be changed here. --> - -<book lang="&language;"> - -<!-- This header contains all of the meta-information for the document such -as Authors, publish date, the abstract, and Keywords --> - -<bookinfo> -<title>The &ksensors; Handbook</title> +<articleinfo> +<title>The &kappname; Handbook</title> <authorgroup> -<author> -<firstname></firstname> -<othername></othername> -<surname>noname</surname> -<affiliation> -<address><email>s@s.org</email></address> -</affiliation> -</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> -<!-- TRANS:ROLES_OF_TRANSLATORS --> +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> <copyright> -<year>1999</year> -<year>2003</year> -<holder>noname</holder> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> </copyright> -<!-- Translators: put here the copyright notice of the translation --> -<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook - and in the FDL itself on how to use it. --> -<legalnotice>&FDLNotice;</legalnotice> - -<!-- Date and version information of the documentation -Don't forget to include this last date and this last revision number, we -need them for translation coordination ! -Please respect the format of the date (YYYY-MM-DD) and of the version -(V.MM.LL), it could be used by automation scripts. -Do NOT change these in the translation. --> -<date>2001-10-18</date> -<releaseinfo>0.1</releaseinfo> - -<!-- Abstract about this handbook --> +<legalnotice>&FDLNotice;</legalnotice> <abstract> <para> -&ksensors; is an application specially designed to do nothing you would -ever want. +&kappname; is a lm-sensors frontend for &tde;. </para> </abstract> -<!-- This is a set of Keywords for indexing by search engines. -Please at least include TDE, the TDE package it is in, the name - of your application, and a few relevant keywords. --> - <keywordset> <keyword>TDE</keyword> -<keyword>ksensors</keyword> -<keyword>nothing</keyword> -<keyword>nothing else</keyword> +<keyword>sensors</keyword> +<keyword>lm-sensors</keyword> </keywordset> -</bookinfo> - -<!-- The contents of the documentation begin here. Label -each chapter so with the id attribute. This is necessary for two reasons: it -allows you to easily reference the chapter from other chapters of your -document, and if there is no ID, the name of the generated HTML files will vary -from time to time making it hard to manage for maintainers and for the CVS -system. Any chapter labelled (OPTIONAL) may be left out at the author's -discretion. Other chapters should not be left out in order to maintain a -consistent documentation style across all TDE apps. --> - -<chapter id="introduction"> -<title>Introduction</title> - -<!-- The introduction chapter contains a brief introduction for the -application that explains what it does and where to report -problems. Basically a long version of the abstract. Don't include a -revision history. (see installation appendix comment) --> - -<para> -&ksensors; is a program that lets you do absolutely nothing. Please report -any problems or feature requests to the &kde; mailing lists. -</para> -</chapter> - -<chapter id="using-ksensors"> -<title>Using &ksensors;</title> - -<!-- This chapter should tell the user how to use your app. You should use as -many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document -your application. --> - -<para> - -<!-- Note that all graphics should be in .png format. Use no gifs because of -patent issues. --> - -<screenshot> -<screeninfo>Here's a screenshot of &ksensors;</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="screenshot.png" format="PNG"/> - </imageobject> - <imageobject> - <imagedata fileref="screenshot.eps" format="EPS"/> - </imageobject> - <textobject> - <phrase>Screenshot</phrase> - </textobject> - </mediaobject> -</screenshot> -</para> - - -<sect1 id="ksensors-features"> -<title>More &ksensors; features</title> - -<para>It slices! It dices! and it comes with a free toaster!</para> -<para> -The Squiggle Tool <guiicon><inlinemediaobject> - <imageobject> - <imagedata fileref="squiggle.png" format="PNG"/> - </imageobject> - <imageobject> - <imagedata fileref="squiggle.eps" format="EPS"/> - </imageobject> - <textobject> - <phrase>Squiggle</phrase> - </textobject> -</inlinemediaobject></guiicon> is used to draw squiggly lines all over -the &ksensors; main window. It's not a bug, it's a feature! -</para> - -</sect1> -</chapter> - -<chapter id="commands"> -<title>Command Reference</title> - -<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the -application windows and their menubar and toolbar commands for easy reference. -Also include any keys that have a special function but have no equivalent in the -menus or toolbars. This may not be necessary for small apps or apps with no tool -or menu bars. --> - -<sect1 id="ksensors-mainwindow"> -<title>The main &ksensors; window</title> - -<sect2> -<title>The File Menu</title> -<para> -<variablelist> -<varlistentry> -<term><menuchoice> -<shortcut> -<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> -</shortcut> -<guimenu>File</guimenu> -<guimenuitem>New</guimenuitem> -</menuchoice></term> -<listitem><para><action>Creates a new document</action></para></listitem> -</varlistentry> -<varlistentry> -<term><menuchoice> -<shortcut> -<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> -</shortcut> -<guimenu>File</guimenu> -<guimenuitem>Save</guimenuitem> -</menuchoice></term> -<listitem><para><action>Saves the document</action></para></listitem> -</varlistentry> -<varlistentry> -<term><menuchoice> -<shortcut> -<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> -</shortcut> -<guimenu>File</guimenu> -<guimenuitem>Quit</guimenuitem> -</menuchoice></term> -<listitem><para><action>Quits</action> &ksensors;</para></listitem> -</varlistentry> -</variablelist> -</para> +</articleinfo> -</sect2> +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for &kappname;.</para> -<sect2> -<title>The <guimenu>Help</guimenu> Menu</title> +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> -<!-- Assuming you have a standard help menu (help, what's this, about --> -<!-- &ksensors;, about TDE) then the documentation is already written. --> -<!-- The following entity is valid anywhere that a variablelist is --> -<!-- valid. --> +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> -&help.menu.documentation; +<para>Thank you for helping and thank you for your patience.</para> -</sect2> +&underFDL; </sect1> -</chapter> - -<chapter id="developers"> -<title>Developer's Guide to &ksensors;</title> - -<!-- (OPTIONAL) A Programming/Scripting reference chapter should be -used for apps that use plugins or that provide their own scripting hooks -and/or development libraries. --> - -<para> -Programming &ksensors; plugins is a joy to behold. Just read through the next -66 pages of API's to learn how! -</para> - -<!-- Use refentries to describe APIs. Refentries are fairly complicated and you -should consult the docbook reference for further details. The example below was -taken from that reference and shortened a bit for readability. --> - -<refentry id="re-1007-unmanagechildren-1"> -<refmeta> -<refentrytitle>XtUnmanageChildren</refentrytitle> -<refmiscinfo>Xt - Geometry Management</refmiscinfo> -</refmeta> -<refnamediv> -<refname>XtUnmanageChildren -</refname> -<refpurpose>remove a list of children from a parent widget's managed -list. -<indexterm id="ix-1007-unmanagechildren-1"><primary>widgets</primary><secondary>removing</secondary></indexterm> -<indexterm id="ix-1007-unmanagechildren-2"><primary>XtUnmanageChildren</primary></indexterm> -</refpurpose> - -</refnamediv> -<refsynopsisdiv> -<refsynopsisdivinfo> -<date>4 March 1996</date> -</refsynopsisdivinfo> -<synopsis> -void XtUnmanageChildren(<replaceable class="parameter">children</replaceable>, <replaceable class="parameter">num_children</replaceable>) - WidgetList <replaceable class="parameter">children</replaceable>; - Cardinal <replaceable class="parameter">num_children</replaceable>; -</synopsis> - -<refsect2 id="r2-1007-unmanagechildren-1"> -<title>Inputs</title> -<variablelist> -<varlistentry> -<term><replaceable class="parameter">children</replaceable> -</term> -<listitem> -<para>Specifies an array of child widgets. Each child must be of -class RectObj or any subclass thereof. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><replaceable class="parameter">num_children</replaceable> -</term> -<listitem> -<para>Specifies the number of elements in <replaceable class="parameter">children</replaceable>. -</para> -</listitem> -</varlistentry> -</variablelist> -</refsect2></refsynopsisdiv> - -<refsect1 id="r1-1007-unmanagechildren-1"> -<title>Description -</title> -<para><function>XtUnmanageChildren()</function> unmaps the specified widgets -and removes them from their parent's geometry management. -The widgets will disappear from the screen, and (depending -on its parent) may no longer have screen space allocated for -them. -</para> -<para>Each of the widgets in the <replaceable class="parameter">children</replaceable> array must have -the same parent. -</para> -<para>See the “Algorithm” section below for full details of the -widget unmanagement procedure. -</para> -</refsect1> - -<refsect1 id="r1-1007-unmanagechildren-2"> -<title>Usage</title> -<para>Unmanaging widgets is the usual method for temporarily -making them invisible. They can be re-managed with -<function>XtManageChildren()</function>. -</para> -<para>You can unmap a widget, but leave it under geometry -management by calling <function>XtUnmapWidget()</function>. You can -destroy a widget's window without destroying the widget by -calling <function>XtUnrealizeWidget()</function>. You can destroy a -widget completely with <function>XtDestroyWidget()</function>. -</para> -<para>If you are only going to unmanage a single widget, it is -more convenient to call <function>XtUnmanageChild()</function>. It is -often more convenient to call <function>XtUnmanageChild()</function> -several times than it is to declare and initialize an array -of widgets to pass to <function>XtUnmanageChildren()</function>. Calling -<function>XtUnmanageChildren()</function> is more efficient, however, -because it only calls the parent's <function>change_managed()</function> -method once. -</para> -</refsect1> - -<refsect1 id="r1-1007-unmanagechildren-3"> -<title>Algorithm -</title> -<para><function>XtUnmanageChildren()</function> performs the following: -</para> -<variablelist> -<varlistentry> -<term>- -</term> -<listitem> -<para>Ignores the child if it already is unmanaged or is being -destroyed. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term>- -</term> -<listitem> -<para>Otherwise, if the child is realized, it makes it nonvisible -by unmapping it. -</para> -</listitem> -</varlistentry> -</variablelist> -<para> -</para> -</refsect1> - -<refsect1 id="r1-1007-unmanagechildren-4"> -<title>Structures</title> -<para>The <type>WidgetList</type> type is simply an array of widgets: -</para> -<screen id="sc-1007-unmanagechildren-1">typedef Widget *WidgetList; -</screen> -</refsect1> -</refentry> - -</chapter> - -<chapter id="faq"> -<title>Questions and Answers</title> - -<!-- (OPTIONAL but recommended) This chapter should include all of the silly -(and not-so-silly) newbie questions that fill up your mailbox. This chapter -should be reserved for BRIEF questions and answers! If one question uses more -than a page or so then it should probably be part of the -"Using this Application" chapter instead. You should use links to -cross-reference questions to the parts of your documentation that answer them. -This is also a great place to provide pointers to other FAQ's if your users -must do some complicated configuration on other programs in order for your -application work. --> - -&reporting.bugs; -&updating.documentation; - -<qandaset id="faqlist"> -<qandaentry> -<question> -<para>My Mouse doesn't work. How do I quit &ksensors;?</para> -</question> -<answer> -<para>You silly goose! Check out the <link linkend="commands">Commands -Section</link> for the answer.</para> -</answer> -</qandaentry> -<qandaentry> -<question> -<para>Why can't I twiddle my documents?</para> -</question> -<answer> -<para>You can only twiddle your documents if you have the foobar.lib -installed.</para> -</answer> -</qandaentry> -</qandaset> -</chapter> - -<chapter id="credits"> - -<!-- Include credits for the programmers, documentation writers, and -contributors here. The license for your software should then be included below -the credits with a reference to the appropriate license file included in the TDE -distribution. --> - -<title>Credits and License</title> - -<para> -&ksensors; -</para> -<para> -Program copyright 2003 noname <email>s@s.org</email> -</para> -<para> -Contributors: -<itemizedlist> -<listitem><para>Konqui the TDE Dragon <email>[email protected]</email></para> -</listitem> -<listitem><para>Tux the Linux Penguin <email>[email protected]</email></para> -</listitem> -</itemizedlist> -</para> - -<para> -Documentation copyright 2003 noname <email>s@s.org</email> -</para> - -<!-- TRANS:CREDIT_FOR_TRANSLATORS --> - -&underFDL; <!-- FDL: do not remove --> - -<!-- Determine which license your application is licensed under, - and delete all the remaining licenses below: - - (NOTE: All documentation are licensed under the FDL, - regardless of what license the application uses) --> - -&underGPL; <!-- GPL License --> -&underBSDLicense; <!-- BSD License --> -&underArtisticLicense; <!-- BSD Artistic License --> -&underX11License; <!-- X11 License --> - -</chapter> - -<appendix id="installation"> -<title>Installation</title> - -<sect1 id="getting-ksensors"> -<title>How to obtain &ksensors;</title> - -<!-- This first entity contains boiler plate for applications that are -part of TDE CVS. You should remove it if you are releasing your -application --> - -&install.intro.documentation; - -</sect1> - -<sect1 id="requirements"> -<title>Requirements</title> - -<!-- -List any special requirements for your application here. This should include: -.Libraries or other software that is not included in tdesupport, -tdelibs, or tdebase. -.Hardware requirements like amount of RAM, disk space, graphics card -capabilities, screen resolution, special expansion cards, etc. -.Operating systems the app will run on. If your app is designed only for a -specific OS, (you wrote a graphical LILO configurator for example) put this -information here. ---> - -<para> -In order to successfully use &ksensors;, you need &kde; 1.1. Foobar.lib is -required in order to support the advanced &ksensors; features. &ksensors; uses -about 5 megs of memory to run, but this may vary depending on your -platform and configuration. -</para> - -<para> -All required libraries as well as &ksensors; itself can be found -on <ulink url="ftp://ftp.ksensors.org">The &ksensors; home page</ulink>. -</para> - -<!-- For a list of updates, you may refer to the application web site -or the ChangeLog file, or ... --> -<para> -You can find a list of changes at <ulink -url="http://apps.kde.org/ksensors">http://apps.kde.org/ksensors</ulink>. -</para> -</sect1> - -<sect1 id="compilation"> -<title>Compilation and Installation</title> - -<!-- This entity contains the boilerplate text for standard --> -<!-- compilation instructions. If your application requires any --> -<!-- special handling, remove it, and replace with your own text. --> - -&install.compile.documentation; - -</sect1> - -<sect1 id="configuration"> -<title>Configuration</title> - -<para>Don't forget to tell your system to start the <filename>dtd</filename> -dicer-toaster daemon first, or &ksensors; won't work !</para> - -</sect1> - -</appendix> - -&documentation.index; -</book> - -<!-- -Local Variables: -mode: sgml -sgml-minimize-attributes:nil -sgml-general-insert-case:lower -sgml-indent-step:0 -sgml-indent-data:nil -End: - -vim:tabstop=2:shiftwidth=2:expandtab ---> +</article> |