/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 11:31:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830113137-v0inyj0limprzfwn
* mandos-options.xml (priority): Added <acronym> tags.

* mandos.xml (NAME): Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
6
6
** [#B] Add more comments to code
7
7
** [#B] Add more if(debug) calls
8
8
** [#B] Seperate more code to function for more readability
 
9
** [#A] Man page: man8/plugin-runner.8mandos
 
10
*** EXIT STATUS
 
11
*** ENVIRONMENT
 
12
    Environment is modified according to options and passed to plugins
 
13
*** EXAMPLE
 
14
    Examples of normal usage, debug usage, debugging single or all
 
15
    plugins, etc.
 
16
*** FILES
 
17
*** SECURITY
 
18
    Note the danger of using this program, since you might lock
 
19
    yourself out of your system without any means of entering the root
 
20
    file system password.  This is, however, very unlikely considering
 
21
    the fallback to getpass(3).
 
22
*** BUGS
 
23
*** SEE ALSO
 
24
    Explaining text on what you can read
9
25
 
10
26
* password-request
11
27
** [#A] Man page: man8/password-request.8mandos
 
28
*** SYNOPSIS
 
29
    Document short options
 
30
*** DESCRIPTION
 
31
    State that this command is not meant to be invoked directly, but
 
32
    is run as a plugin from mandos-client(8) and only run in the
 
33
    initrd environment, not the real system.
 
34
*** PURPOSE
 
35
    As in mandos.xml
 
36
*** OVERVIEW
 
37
    As in mandos.xml
 
38
*** EXIT STATUS
 
39
*** ENVIRONMENT
 
40
    Note that it does *not* currently use cryptsource or crypttarget.
12
41
*** FILES
13
42
    Describe the key files and the key ring files.  Also note that
14
43
    they should normally have been automatically created.
59
88
** Enable client
60
89
 
61
90
* Man pages
 
91
** Tags
 
92
   Go through all man pages to conform to the style of tags chosen in
 
93
   [[http://svn.debian.org/wsvn/debian-xml-sgml/packages/docbook-xsl/trunk/debian/examples/foo.1.example_manpage.xml?op=file&rev=0&sc=0][foo.1.example_manpage.xml]].  In particular:
 
94
*** SYNOPSIS
 
95
    <arg> with inner <replaceable> and <option> tags
 
96
*** OPTIONS
 
97
    Separate <term> tags with <option> and <replaceable> tags
62
98
** Use xinclude for common sections
63
 
   Like authors, etc.
 
99
   Like copyright, authors, etc.
64
100
 
65
101
 
66
102
* Installer