kdoctools/man-template.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   3 <!ENTITY % English "INCLUDE">
   4 ]>
   5
   6 <refentry lang="&language;">
   7 <refentryinfo>
   8 <title>KDE User's Manual</title>
   9 <author><personname>
  10 <firstname><!-- --Your first name-- --></firstname>
  11 <surname><!-- --Your last name-- --></surname>
  12 </personname>
  13 <affiliation><address><email><!-- --Your email address-- --></email></address></affiliation></author>
  14 <date><!-- --Date when this manpage was written, in the ISO 8601 format
  15 'yyyy-mm-dd'-- --></date>
  16 <productname>K Desktop Environment</productname>
  17 </refentryinfo>
  18
  19 <refmeta>
  20 <refentrytitle><command><!-- --The command this page is about-- --></command></refentrytitle>
  21 <manvolnum><!-- --The section this page should be in-- --></manvolnum>
  22 </refmeta>
  23
  24 <refnamediv>
  25 <refname><command><!-- --The command this page is about-- --></command></refname>
  26 <refpurpose><!-- --Very brief description, suitable for 'whatis'-- --></refpurpose>
  27 </refnamediv>
  28
  29 <refsynopsisdiv>
  30 <cmdsynopsis>
  31 <command><!-- --The command this page is about-- --></command>
  32 <arg choice="req"><!-- --Required command specific options-- --></arg>
  33 <arg choice="opt"><!-- --Optional command specific options-- --></arg>
  34 <arg choice="opt">KDE Generic Options</arg>
  35 <arg choice="opt">Qt Generic Options</arg>
  36 </cmdsynopsis>
  37 </refsynopsisdiv>
  38
  39 <refsect1>
  40 <title>Description</title>
  41 <para><!-- --Description of the app, what it's for, what it does and doesn't
  42 do.-- --> </para>
  43
  44 </refsect1>
  45
  46 <refsect1>
  47 <title>Options</title>
  48 <para>App options, in a variablelist</para>
  49
  50 </refsect1>
  51
  52 <!-- --The Following sections are optional, but recommended if they are
  53 applicable.-- -->
  54
  55 <refsect1>
  56 <title>Environment</title>
  57 <para><!-- --Environment variablesars that affect this command, how to set
  58 them, who sets them, how they affect it, probably in a variablelist.  Only for
  59 man sections 1, 6, 7 and 8-- --></para>
  60 </refsect1>
  61
  62 <refsect1>
  63 <title>Files</title>
  64 <para><!-- --Files used by this command (eg, rc files, locations of caches
  65 etc.)  who puts them there, how they are configured, and if it's safe
  66 to remove them, probably in a variablelist.-- --></para>
  67 </refsect1>
  68
  69 <refsect1>
  70 <title>See Also</title>
  71 <para><!-- --foo(1)-style references, use a simplelist for these-- --></para>
  72
  73 <para>More detailed user documentation is available from <ulink
  74 url="help:/<!-- --commandname-- -->">help:/<!-- --command-- --></ulink>
  75 (either enter this <acronym>URL</acronym> into &konqueror;, or run
  76 <userinput><command>khelpcenter</command>
  77 <parameter>help:/<!-- --command-- --></parameter></userinput>).</para>
  78
  79 <para>There is also further information available at <!-- --link to
  80 website if applicable-- --></para>
  81 </refsect1>
  82
  83 <refsect1>
  84 <title>Examples</title>
  85 <para><!-- -- Give examples on how to use the program with different parameters
  86 here, don't forget to explain what each invocation does exactly. Be verbose,
  87 many users find this the most useful part of the documentation! -- --></para>
  88 </refsect1>
  89
  90 <refsect1>
  91 <title>Standards</title>
  92
  93 <para><!-- --If the app adheres to any particular standards or RFC's, note
  94 them here.-- --> </para>
  95 </refsect1>
  96
  97 <refsect1>
  98 <title>History</title>
  99 <para><!-- --Programs derived from other sources sometimes have this, or you
 100 might keep a modification log here.  If the log gets overly long or detailed,
 101 consider maintaining it in a separate file, though.-- -->
 102 </refsect1>
 103
 104 <refsect1>
 105 <title>Bugs</title>
 106 <para><!-- --Things that cause specific errors, so that people may avoid it,
 107 or at least will be prepared for it.-- -->
 108 </para>
 109 </refsect1>
 110
 111 <refsect1>
 112 <title>Restrictions</title>
 113 <para><!-- --Bugs you don't plan to fix. :-)-- --></para>
 114 </refsect1>
 115
 116 <refsect1>
 117 <title>Authors</title>
 118 <para><!-- --Author information of the developer and man page writer.-- --></para>
 119 </refsect1>
 120
 121 </refentry>