Mention that the -L, -R and -U options are not supported on all platforms.

This commit is contained in:
Guus Sliepen 2013-01-14 12:58:24 +01:00
parent 5b88f5ba74
commit c90c431bc9
2 changed files with 8 additions and 0 deletions

View file

@ -1847,6 +1847,8 @@ This option can be used more than once to specify multiple configuration variabl
Lock tinc into main memory.
This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
This option is not supported on all platforms.
@item --logfile[=@var{file}]
Write log entries to a file instead of to the system logging facility.
If @var{file} is omitted, the default is @file{@value{localstatedir}/log/tinc.@var{netname}.log}.
@ -1867,11 +1869,14 @@ Note that this option alone does not do any good without -U/--user, below.
Note also that tinc can't run scripts anymore (such as tinc-down or host-up),
unless it's setup to be runnable inside chroot environment.
This option is not supported on all platforms.
@item -U, --user=@var{user}
Switch to the given @var{user} after initialization, at the same time as
chroot is performed (see --chroot above). With this option tinc drops
privileges, for added security.
This option is not supported on all platforms.
@item --help
Display a short reminder of these runtime options and terminate.

View file

@ -81,6 +81,7 @@ This option can be used more than once to specify multiple configuration variabl
.It Fl L, -mlock
Lock tinc into main memory.
This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
This option is not supported on all platforms.
.It Fl -logfile Ns Op = Ns Ar FILE
Write log entries to a file instead of to the system logging facility.
If
@ -104,10 +105,12 @@ Only useful for debugging.
With this option tinc chroots into the directory where network
config is located (@sysconfdir@/tinc/NETNAME if -n option is used,
or to the directory specified with -c option) after initialization.
This option is not supported on all platforms.
.It Fl U, -user Ns = Ns Ar USER
setuid to the specified
.Ar USER
after initialization.
This option is not supported on all platforms.
.It Fl -help
Display short list of options.
.It Fl -version