tdelibs
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

man-template.docbook 3.8KB

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