/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 intro.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:
intro.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY TIMESTAMP "2019-08-04">
 
4
<!ENTITY TIMESTAMP "2019-04-10">
5
5
<!ENTITY % common SYSTEM "common.ent">
6
6
%common;
7
7
]>
384
384
      plugin requirements.
385
385
    </para>
386
386
  </refsect1>
387
 
 
388
 
  <refsect1 id="systemd">
389
 
    <title>SYSTEMD</title>
390
 
    <para>
391
 
      More advanced startup systems like <citerefentry><refentrytitle
392
 
      >systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
393
 
      already have their own plugin-like mechanisms for allowing
394
 
      multiple agents to independently retrieve a password and deliver
395
 
      it to the subsystem requesting a password to unlock the root
396
 
      file system.  On these systems, it would make no sense to run
397
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle
398
 
      ><manvolnum>8mandos</manvolnum></citerefentry>, the plugins of
399
 
      which would largely duplicate the work of (and conflict with)
400
 
      the existing systems prompting for passwords.
401
 
    </para>
402
 
    <para>
403
 
      As for <citerefentry><refentrytitle>systemd</refentrytitle
404
 
      ><manvolnum>1</manvolnum></citerefentry> in particular, it has
405
 
      its own <ulink
406
 
      url="https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents/"
407
 
      >Password Agents</ulink> system.  Mandos uses this via its
408
 
      <citerefentry><refentrytitle>password-agent</refentrytitle
409
 
      ><manvolnum>8mandos</manvolnum></citerefentry> program, which
410
 
      is run instead of <citerefentry><refentrytitle
411
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum
412
 
      ></citerefentry> when <citerefentry><refentrytitle
413
 
      >systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
414
 
      is used during system startup.
415
 
    </para>
416
 
  </refsect1>
 
387
  
417
388
  <refsect1 id="bugs">
418
389
    <title>BUGS</title>
419
390
    <xi:include href="bugs.xml"/>
434
405
      <manvolnum>8</manvolnum></citerefentry>,
435
406
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
436
407
      <manvolnum>8mandos</manvolnum></citerefentry>,
437
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
438
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
439
408
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
440
409
      <manvolnum>8mandos</manvolnum></citerefentry>,
441
410
      <citerefentry><refentrytitle>password-prompt</refentrytitle>