/mandos/trunk

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

« back to all changes in this revision

Viewing changes to overview.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

Lines of Context:
overview.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
2
4
<para>
3
 
  This is part of the Mandos system for allowing host computers to
4
 
  have encrypted root file systems and also be capable of remote and
5
 
  unattended reboots.  The host computers run a small client program
6
 
  in the initial RAM disk environment which will communicate with a
7
 
  server over a network.  The clients are identified by the server
8
 
  using a OpenPGP key; each client has one unique to it.  The server
9
 
  sends the clients an encrypted password.  The encrypted password is
10
 
  decrypted by the clients using the same OpenPGP key, and the
11
 
  password is then used to unlock the root file system, whereupon the
12
 
  host computers can continue booting normally.
 
5
  This is part of the Mandos system for allowing computers to have
 
6
  encrypted root file systems and at the same time be capable of
 
7
  remote and/or unattended reboots.  The computers run a small client
 
8
  program in the initial <acronym>RAM</acronym> disk environment which
 
9
  will communicate with a server over a network.  All network
 
10
  communication is encrypted using <acronym>TLS</acronym>.  The
 
11
  clients are identified by the server using a TLS key; each client
 
12
  has one unique to it.  The server sends the clients an encrypted
 
13
  password.  The encrypted password is decrypted by the clients using
 
14
  a separate OpenPGP key, and the password is then used to unlock the
 
15
  root file system, whereupon the computers can continue booting
 
16
  normally.
13
17
</para>