[ previous ] [ Contents ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ next ]

Debian doc-base Manual

Abstract

This manual describes what doc-base is and how it can be used to manage online manuals on Debian systems.

Copyright Notice

copyright ©1998, Christian Schwarz
copyright ©1999 – 2002, Adam Di Carlo
copyright ©2006 – 2009, Robert Luberda

This manual is free software; you may 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, or (at your option) any later version.

This 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.

A copy of the GNU General Public License is available as /usr/share/common-licenses/GPL in the Debian GNU/Linux distribution or on the World Wide Web at the GNU website. You can also obtain it by writing to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

Contents

• 1 About doc-base
• 2 The packages interface
  • 2.1 Introduction
  • 2.2 Document IDs
  • 2.3 Control Files
    • 2.3.1 Example
    • 2.3.2 Syntax of the control file
      • 2.3.2.1 The main section
      • 2.3.2.2 Format sections
    • 2.3.3 The section field
  • 2.4 Registering Documents With doc-base
  • 2.5 doc-base 0.8.x features and incompatibilities
    • 2.5.1 Splitting control files over multiple binary packages
    • 2.5.2 Registering local documents
    • 2.5.3 dpkg triggers
  • 2.6 Checking Syntax of Control Files
• 3 Getting information about installed documents
• 4 TODO List
  • 4.1 Roadmap for 0.9.* releases
  • 4.2 Old TODO entries

[ previous ] [ Contents ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ next ]

Debian doc-base Manual