File: ipsec-pluto.8.xml

package info (click to toggle)
libreswan 5.2-2.3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 81,644 kB
  • sloc: ansic: 129,988; sh: 32,018; xml: 20,646; python: 10,303; makefile: 3,022; javascript: 1,506; sed: 574; yacc: 511; perl: 264; awk: 52
file content (900 lines) | stat: -rw-r--r-- 24,694 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry id="pluto8">
  <refmeta>
    <refentrytitle>IPSEC-PLUTO</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="date">29 June 2014</refmiscinfo>
    <refmiscinfo class="source">Libreswan</refmiscinfo>
    <refmiscinfo class="version">@@IPSECVERSION@@</refmiscinfo>
    <refmiscinfo class="manual">Executable programs</refmiscinfo>
  </refmeta>

  <refnamediv id="name">
    <refname>ipsec-pluto</refname>
    <refname>pluto</refname>
    <refpurpose>Internet Key Exchange daemon</refpurpose>
  </refnamediv>

  <!-- body begins here -->
  <refsynopsisdiv id="synopsis">

    <cmdsynopsis>

      <command>ipsec pluto</command>
      <arg choice="opt">--help</arg>
      <arg choice="opt">--version</arg>
      <sbr/>
      <arg choice="opt">--nofork</arg>
      <arg choice="opt">--rundir <replaceable>path</replaceable></arg>
      <arg choice="opt">--leak-detective</arg>
      <arg choice="opt">--efence-protect</arg>
      <sbr/>
      <arg choice="opt">--stderrlog</arg>
      <arg choice="opt">--logfile <replaceable>filename</replaceable></arg>
      <arg choice="opt">--log-no-time</arg>
      <arg choice="opt">--log-no-append</arg>
      <arg choice="opt">--log-no-ip</arg>
      <arg choice="opt">--log-no-audit</arg>
      <sbr/>
      <arg choice="opt">--config <replaceable>filename</replaceable></arg>
      <arg choice="opt">--secretsfile <replaceable>secrets-file</replaceable></arg>
      <arg choice="opt">--ipsecdir <replaceable>dirname</replaceable></arg>
      <arg choice="opt">--nssdir <replaceable>dirname</replaceable></arg>
      <arg choice="opt">--coredir <replaceable>dirname</replaceable></arg>
      <sbr/>
      <arg choice="opt">--vendorid <replaceable>VID</replaceable></arg>
      <arg choice="opt">--uniqueids</arg>
      <arg choice="opt">--virtual-private <replaceable>network_list</replaceable></arg>
      <arg choice="opt">--keep-alive <replaceable>delay_sec</replaceable></arg>
      <arg choice="opt">--force-busy</arg>
      <arg choice="opt">--crl-strict</arg>
      <arg choice="opt">--crlcheckinterval</arg>
      <arg choice="opt">--listen <replaceable>ipaddr</replaceable></arg>
      <arg choice="opt">--nhelpers <replaceable>number</replaceable></arg>
      <arg choice="opt">--seedbits <replaceable>numbits</replaceable></arg>
      <arg choice="opt">--statsbin <replaceable>filename</replaceable></arg>
      <arg choice="opt">--secctx-attr-type <replaceable>number</replaceable></arg>
      <sbr/>
      <arg choice="opt">--use-xfrm</arg>
      <arg choice="opt">--use-bsdkame</arg>
    </cmdsynopsis>

  </refsynopsisdiv>

  <refsect1 id="description">

    <title>DESCRIPTION</title>

    <para>
      <command>pluto</command> is
      <application>Libreswan's</application> Internet Key Exchange
      (IKE) daemon.
    </para>

    <para>
      <command>pluto</command> is not normally run directly.  Instead
      the daemon is controlled the hosts <citerefentry>
      <refentrytitle>init</refentrytitle> <manvolnum>8</manvolnum>
      </citerefentry> system (such as
      <citerefentry> <refentrytitle>systemd</refentrytitle>
      <manvolnum>1</manvolnum> </citerefentry> or <citerefentry>
      <refentrytitle>rc</refentrytitle> <manvolnum>8</manvolnum>
      </citerefentry>) or the command <command>ipsec</command> (see
      <citerefentry> <refentrytitle>ipsec</refentrytitle>
      <manvolnum>8</manvolnum> </citerefentry>).
    </para>

    <para>
      For more general information on <application>Libreswan</application>
      see <citerefentry> <refentrytitle>libreswan</refentrytitle>
      <manvolnum>7</manvolnum> </citerefentry>.
    </para>

    <para>
      For information on how to configure
      <application>Libreswan</application> and the
      <command>pluto</command> daemon see <citerefentry>
      <refentrytitle>ipsec.conf</refentrytitle>
      <manvolnum>5</manvolnum>
      </citerefentry>.
    </para>

    <refsect2>
      <title>
	Help Options
      </title>

      <variablelist>
	<varlistentry>
          <term>
	    <option>--help</option>
	  </term>
          <listitem>
            <para>
	      show <command>pluto's</command> usage message
	    </para>
          </listitem>
	</varlistentry>
	<varlistentry>
          <term>
	    <option>--version</option>
	  </term>
          <listitem>
            <para>
	      show <application>Libreswan's</application> version details
	    </para>
          </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="starting">
      <title>Starting pluto</title>

      <para>
	When starting, <command>pluto</command> attempts to create a
	lockfile with the name
	<filename>@@RUNDIR@@/pluto.pid</filename>.  If the lockfile
	cannot be created, <command>pluto</command> exits - this
	prevents multiple <command>pluto</command>s from competing.
	Any "leftover" lockfile must be manually removed before
	<command>pluto</command> will run.  <command>pluto</command>
	then writes its <replaceable>PID</replaceable> into this file
	so that scripts can find it.  <command>pluto</command> then
	forks and the parent exits (this is the conventional "daemon
	fork").
      </para>

      <para>
	The following options alter how <command>pluto</command> starts:
      </para>

      <variablelist>
	<varlistentry>
          <term>
	    <option>--nofork</option>
	  </term>
          <listitem>
            <para>
	      disable "daemon fork"
	    </para>
	    <para>
	      In addition, after the lock file and control socket are
	      created, print the line "Pluto initialized" to standard
	      out.
	    </para>
          </listitem>
	</varlistentry>
	<varlistentry>
          <term>
	    <option>--rundir <filename><replaceable>path</replaceable></filename></option>
	  </term>
          <listitem>
	    <para>
	      change the <filename>run</filename> directory from the
	      default <filename>@@RUNDIR@@</filename>)
	    </para>
            <para>
	      The <filename>run</filename> directory contains:
	      <variablelist>
		<varlistentry>
		  <term>
		    <filename><replaceable>path</replaceable>/pluto.ctl</filename>
		  </term>
		  <listitem>
		    <para>
		      the socket through which <command>whack</command>
		      communicates with <command>pluto</command>
		    </para>
		  </listitem>
		</varlistentry>
		<varlistentry>
		  <term>
		    <filename><replaceable>path</replaceable>/pluto.pid</filename>
		  </term>
		  <listitem>
		    <para>
		      the lockfile to prevent multiple
		      <command>pluto</command> instances
		    </para>
		  </listitem>
		</varlistentry>
	      </variablelist>
	    </para>
          </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--leak-detective</option>
	  </term>
	  <listitem>
	    <para>
	      enable leak detective
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--efence-protect</option>
	  </term>
	  <listitem>
	    <para>
	      enable efence protection
	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2>

      <title>
	Logging
      </title>

      <para>
	All logging, including diagnostics, are sent to <citerefentry>
	<refentrytitle>syslog</refentrytitle>
	<manvolnum>3</manvolnum> </citerefentry> with
	<property>facility=authpriv</property>; it decides where to
	put these messages.  The following options alter this
	behaviour:
      </para>

      <variablelist>
	<varlistentry>
          <term>
	    <option>--stderrlog</option>
	  </term>
          <listitem>
            <para>
	      direct logging to standard error instead of a log file
	    </para>
	    <para>
	      Often combined with <option>--nofork</option> debugging
	      <command>pluto</command>.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
          <term>
	    <option>--logfile <filename><replaceable>filename</replaceable></filename></option>
	  </term>
          <listitem>
            <para>
	      direct logging to <filename><replaceable>filename</replaceable></filename>
	      instead of  <citerefentry>
	      <refentrytitle>syslog</refentrytitle>
	      <manvolnum>3</manvolnum> </citerefentry>
	    </para>
	    <para>
	      See <citerefentry>
	      <refentrytitle>ipsec.conf</refentrytitle>
	      <manvolnum>5</manvolnum> </citerefentry> and
	      <property>logfile=<filename><replaceable>filename</replaceable></filename></property>.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
          <term>
	    <option>--log-no-time</option>
	  </term>
          <listitem>
            <para>
	      do not include a timestamp prefix when logging to a file
	    </para>
	    <para>
	      See <citerefentry>
	      <refentrytitle>ipsec.conf</refentrytitle>
	      <manvolnum>5</manvolnum> </citerefentry> and
	      <property>logtime=no</property>.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
          <term>
	    <option>--log-no-append</option>
	  </term>
          <listitem>
            <para>
	      do not append to the end of an existing log file
	    </para>
	    <para>
	      See <citerefentry>
	      <refentrytitle>ipsec.conf</refentrytitle>
	      <manvolnum>5</manvolnum> </citerefentry> and
	      <property>logappend=no</property>.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--log-no-ip</option>
	  </term>
	  <listitem>
	    <para>
	      do not include IP addresses when logging
	    </para>
	    <para>
	      See <citerefentry>
	      <refentrytitle>ipsec.conf</refentrytitle>
	      <manvolnum>5</manvolnum> </citerefentry> and
	      <property>logip=no</property>.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--log-no-audit</option>
	  </term>
	  <listitem>
	    <para>
	      do not generate audit logs (on systems that support
	      Linux Auditing)
	    </para>
	    <para>
	      See <citerefentry>
	      <refentrytitle>ipsec.conf</refentrytitle>
	      <manvolnum>5</manvolnum> </citerefentry> and
	      <property>audit-log=no</property>.
	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2>
      <title>
	Configuration Files
      </title>

      <para>
	The following options overide <command>pluto's</command>
	default configuration parameters:
      </para>

      <variablelist>
	<varlistentry>
	  <term>
	    <option>--config <replaceable>filename</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	      specify a
	      <citerefentry>
	      <refentrytitle>ipsec.conf</refentrytitle>
	      <manvolnum>5</manvolnum> </citerefentry> file containing
	      additional configuration parameters
	    </para>
	    <para>
	      The "config" section of
	      <replaceable>filename</replaceable> will be loaded.
	    </para>
	    <para>
	      Normally, <command>pluto</command> is started using
	      <command>ipsec start</command>, and that passes the
	      parameter <option>--config
	      <filename>@@IPSEC_CONF@@</filename></option> so that the
	      default configuration is read.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--secretsfile <replaceable>secrets-file</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	      specify the file for authentication secrets
	    </para>
	    <para>
	      This name is
	      subject to "globbing" as in <citerefentry>
	      <refentrytitle>sh</refentrytitle>
	      <manvolnum>1</manvolnum> </citerefentry>, so every file
	      with a matching name is processed.  Quoting is generally
	      needed to prevent the shell from doing the globbing.
	    </para>
	    <para>
	      Default is <filename>@@IPSEC_SECRETS@@</filename>.  See <citerefentry>
	      <refentrytitle>ipsec.secrets</refentrytitle>
	      <manvolnum>5</manvolnum> </citerefentry>.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--ipsecdir <replaceable>dirname</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	      the directory containing additional configuration files
	    </para>
	    <para>
	      Default is <filename>@@IPSEC_CONFDDIR@@</filename>.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--nssdir <replaceable>dirname</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	      the directory containing the NSS trust store
	    </para>
	    <para>
	      Default is <filename>@@IPSEC_NSSDIR@@</filename>.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--coredir <replaceable>dirname</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	      the directory to write a core file should
	      <command>pluto</command> abort
	    </para>
	    <para>
	      Default is <filename>@@RUNDIR@@</filename>.
	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2>

      <title>
	Other Options
      </title>

      <para>
	The following options tweak <command>pluto's</command>
	behaviour:
      </para>

      <variablelist>
	<varlistentry>
	  <term>
	    <option>--vendorid <replaceable>VID</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--uniqueids</option>
	  </term>
	  <listitem>
	    <para>
	      require all connections to have a unique identifier
	    </para>
	    <para>
	      If this option has been selected, whenever a new ISAKMP SA
	      is established, any connection with the same Peer ID but a
	      different Peer IP address is unoriented (causing all its
	      SAs to be deleted). This helps clean up dangling SAs when
	      a connection is lost and then regained at another IP
	      address.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--virtual-private <replaceable>network_list</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	      Pluto supports RFC 3947 NAT-Traversal.  The allowed range behind the NAT routers is submitted using the
	      <option>--virtual-private</option> option.
	    </para>
	    <para>
	      See <citerefentry>
	      <refentrytitle>ipsec.conf</refentrytitle>
	      <manvolnum>5</manvolnum> </citerefentry> for the syntax
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--keep-alive <replaceable>delay_sec</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	      The <option>--keep-alive</option> sets the delay (in
	      seconds) of these keep-alive packets. The newer NAT-T
	      standards support <emphasis>port floating</emphasis>, and
	      Libreswan enables this per default.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--force-busy</option>
	  </term>
	  <listitem>
	    <para>
	      If this option has been selected, pluto will be forced to
	      be "busy". In this state, which happens when there is a
	      Denial of Service attack, will force pluto to use cookies
	      before accepting new incoming IKE packets.  Cookies are
	      send and required in ikev1 Aggressive Mode and in ikev2.
	      This option is mostly used for testing purposes, but can
	      be selected by paranoid administrators as well.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--crl-strict</option>
	  </term>
	  <listitem>
	    <para>
	      reject authentication using X.509 until a valid
	      certificate revocation list has been loaded
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--crlcheckinterval</option>
	  </term>
	  <listitem>
	    <para>
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--listen <replaceable>ipaddr</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--nhelpers <replaceable>number</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	      specify the number of threads to use when offloading
	      cryptographic operations
	    </para>
	    <para>
	      Pluto can also use helper children to off-load
	      cryptographic operations. This behavior can be fine tuned
	      using the <option>--nhelpers</option>. Pluto will start
	      <emphasis>(n-1)</emphasis> of them, where
	      <emphasis>n</emphasis> is the number of CPU's you have
	      (including hypherthreaded CPU's). A value of
	      <emphasis>0</emphasis> forces pluto to do all operations
	      in the main process. A value of <emphasis>-1</emphasis>
	      tells pluto to perform the above calculation. Any other
	      value forces the number to that amount.
	    </para>
	    <para>
	      See <citerefentry>
	      <refentrytitle>ipsec.conf</refentrytitle>
	      <manvolnum>5</manvolnum> </citerefentry> and
	      <property>nhelpers=<filename><replaceable>number</replaceable></filename></property>.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--seedbits <replaceable>numbits</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	      specify the number of seed bits to read from the RNG
	      before starting
	    </para>
	    <para>
	      Pluto uses the NSS crypto library as its random source.
	      Some government Three Letter Agency requires that pluto
	      reads 440 bits from /dev/random and feed this into the NSS
	      RNG before drawing random from the NSS library, despite
	      the NSS library itself already seeding its internal state.
	      As this process can block pluto for an extended time, the
	      default is to not perform this redundant seeding. The
	      <option>--seedbits</option> option can be used to specify
	      the number of bits that will be pulled from /dev/random
	      and seeded into the NSS RNG.
	    </para>
	    <para>
	      See  <citerefentry>
	      <refentrytitle>ipsec.conf</refentrytitle>
	      <manvolnum>5</manvolnum> </citerefentry> and
	      <property>seedbits=<filename><replaceable>number</replaceable></filename></property>.
	    </para>
	    <para>
	      This option
	      should not be used by most people.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--statsbin <replaceable>filename</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--secctx-attr-type <replaceable>number</replaceable></option>
	  </term>
	  <listitem>
	    <para>
	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>

      <para>
	<command>Libreswan</command> supports different IPstacks on
	different operating systems.  Since most IPstacks have died the
	list is very short:
      </para>

      <variablelist>
	<varlistentry>
	  <term>
	    <option>--use-xfrm</option>
	  </term>
	  <listitem>
	    <para>
	      linux only
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    <option>--use-bsdkame</option>
	  </term>
	  <listitem>
	    <para>
	      BSD only
	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>

    </refsect2>

    <refsect2>

      <title>
	Debugging
      </title>

      <para>
	When running <command>pluto</command> under a debugger, the
	options <option>--nofork</option> and
	<option>--stderrlog</option> are recommended.
      </para>

      <para>
	<command>pluto</command> is willing to produce a prodigious
	amount of debugging information.  There are several classes of
	debugging output, and <command>pluto</command> may be directed
	to produce a selection of them.  All lines of debugging output
	are prefixed with "|" to distinguish them from normal
	diagnostic messages.
      </para>

      <para>
	See <citerefentry>
	<refentrytitle>ipsec.conf</refentrytitle>
	<manvolnum>5</manvolnum> </citerefentry> and
	<property>plutodebug=<replaceable>options</replaceable></property>.
      </para>

      <para>
	Very occasionally it is necessary to enable debugging early in
	<command>pluto's</command> startup process.  The follow
	options enable this:
      </para>

      <variablelist>

	<varlistentry>
          <term>
	    <option>--debug help</option> (whack only)
	  </term>
          <listitem>
            <para>
	      List the debugging classes recognised by
	      <command>pluto</command>.
	    </para>
          </listitem>
	</varlistentry>

	<varlistentry>
          <term>
	    <option>--debug none</option>
	  </term>
          <listitem>
            <para>
	      Disable logging for all debugging classes.
	    </para>
          </listitem>
	</varlistentry>

	<varlistentry>
          <term>
	    <option>--debug base</option>
	  </term>
          <listitem>
            <para>
	      Enable debug-logging.
	    </para>
          </listitem>
	</varlistentry>

	<varlistentry>
          <term>
	    <option>--debug cpu-usage</option>
	  </term>
          <listitem>
            <para>
	      Enable cpu-usage logging.
	    </para>
          </listitem>
	</varlistentry>

	<varlistentry>
          <term>
	    <option>--debug <replaceable>class</replaceable></option>
	  </term>
          <term>
	    <option>--no-debug <replaceable>class</replaceable></option>
	  </term>
          <term>
	    <option>--debug no-<replaceable>class</replaceable></option>
	  </term>
          <listitem>
            <para>
	      Enable (disable) logging of the specified debugging
	      <replaceable>class</replaceable> (<option>--debug
	      help</option> lists debugging classes supported by this
	      version of <command>pluto</command>).
	    </para>
          </listitem>
	</varlistentry>

      </variablelist>

    </refsect2>

  </refsect1>

  <refsect1 id="signals">

    <title>SIGNALS</title>

    <para>
      <command>pluto</command> responds to <constant>SIGHUP</constant>
      by issuing a suggestion that <command>ipsec listen</command>
      might have been intended.
    </para>

    <para>
      <command>pluto</command> exits when it receives
      <constant>SIGTERM</constant>.
    </para>
  </refsect1>

  <refsect1 id="exit_status">
    <title>EXIT STATUS</title>

    <para>
      <command>pluto</command> normally forks a daemon process, so the
      exit status is a very preliminary result.
    </para>

    <variablelist>
      <varlistentry>
        <term><constant>0</constant></term>
        <listitem>
          <para>means that all is OK so far.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><constant>1</constant></term>
        <listitem>
          <para>means that something was wrong.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><constant>10</constant></term>
        <listitem>
          <para>means that the lock file already exists.</para>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1 id="files">
    <title>FILES</title>

    <para>
      <filename>@@RUNDIR@@/pluto.pid</filename>
      <filename>@@RUNDIR@@/pluto.ctl</filename>
      <filename>@@IPSEC_SECRETS@@</filename>
      <filename>@@IPSEC_CONF@@</filename>
    </para>

  </refsect1>

  <refsect1 id="environment">
    <title>ENVIRONMENT</title>

    <para>
      <command>pluto</command> does not use any environment variables.
    </para>
  </refsect1>

  <refsect1 id="see_also">
    <title>SEE ALSO</title>

    <para>
      The rest of the Libreswan distribution, in particular
      <citerefentry>
	<refentrytitle>libreswan</refentrytitle>
	<manvolnum>7</manvolnum>
	</citerefentry>.
    </para>
  </refsect1>

  <refsect1 id="history">
    <title>HISTORY</title>

    <para>
      This code is released under the GPL terms. See the accompanying
      files CHANGES COPYING and CREDITS.* for more details.
    </para>

    <para>
      Detailed history (including FreeS/WAN and Openswan) can be found
      in the docs/ directory.
    </para>

  </refsect1>

  <refsect1 id="bugs">
    <title>BUGS</title>

    <para>
      Please see <ulink
      url="https://github.com/libreswan/libreswan/issues">https://github.com/libreswan/libreswan/issues</ulink>
      for a list of currently known bugs and missing features.
    </para>
  </refsect1>

  <refsect1 id='author'>
    <title>AUTHOR</title>
    <para>
      <author><personname><firstname>Paul</firstname><surname>Wouters</surname></personname></author>
      <author><personname><firstname>Andrew</firstname><surname>Cagney</surname></personname></author>
    </para>
  </refsect1>
</refentry>