diff options
Diffstat (limited to 'doc/anylike.8')
| -rw-r--r-- | doc/anylike.8 | 117 |
1 files changed, 117 insertions, 0 deletions
diff --git a/doc/anylike.8 b/doc/anylike.8 new file mode 100644 index 0000000..e565976 --- /dev/null +++ b/doc/anylike.8 @@ -0,0 +1,117 @@ +'\" t +.\" Title: anylike +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/> +.\" Date: 12/25/2009 +.\" Manual: anylike user manual +.\" Source: anylike trunk +.\" Language: English +.\" +.TH "ANYLIKE" "8" "12/25/2009" "anylike trunk" "anylike user manual" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +anylike \- lua based ikev2 implementation +.SH "SYNOPSIS" +.sp +.nf +uanytun + [ \fB\-h|\-\-help\fR ] + [ \fB\-D|\-\-nodaemonize\fR ] + [ \fB\-u|\-\-username\fR <username> ] + [ \fB\-g|\-\-groupname\fR <groupname> ] + [ \fB\-C|\-\-chroot\fR <path> ] + [ \fB\-P|\-\-write\-pid\fR <filename> ] + [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]] ] +.fi +.SH "DESCRIPTION" +.sp +\fBanylike\fR is a \&... +.SH "OPTIONS" +.sp +The following options can be passed to the \fBanylike\fR daemon: +.PP +\fB\-D, \-\-nodaemonize\fR +.RS 4 +This option instructs +\fBanylike\fR +to run in foreground instead of becoming a daemon which is the default\&. +.RE +.PP +\fB\-u, \-\-username <username>\fR +.RS 4 +run as this user\&. If no group is specified (\fB\-g\fR) the default group of the user is used\&. The default is to not drop privileges\&. +.RE +.PP +\fB\-g, \-\-groupname <groupname>\fR +.RS 4 +run as this group\&. If no username is specified (\fB\-u\fR) this gets ignored\&. The default is to not drop privileges\&. +.RE +.PP +\fB\-C, \-\-chroot <path>\fR +.RS 4 +Instruct +\fBanylike\fR +to run in a chroot jail\&. The default is to not run in chroot\&. +.RE +.PP +\fB\-P, \-\-write\-pid <filename>\fR +.RS 4 +Instruct +\fBanylike\fR +to write it\(cqs pid to this file\&. The default is to not create a pid file\&. +.RE +.PP +\fB\-L, \-\-log <target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR +.RS 4 +add log target to logging system\&. This can be invoked several times in order to log to different targets at the same time\&. Every target hast its own log level which is a number between 0 and 5\&. Where 0 means disabling log and 5 means debug messages are enabled\&. + +The file target can be used more the once with different levels\&. If no target is provided at the command line a single target with the config +\fBsyslog:3,anylike,daemon\fR +is added\&. + +The following targets are supported: +.PP +\fBsyslog\fR +.RS 4 +log to syslog daemon, parameters <level>[,<logname>[,<facility>]] +.RE +.PP +\fBfile\fR +.RS 4 +log to file, parameters <level>[,<path>] +.RE +.PP +\fBstdout\fR +.RS 4 +log to standard output, parameters <level> +.RE +.PP +\fBstderr\fR +.RS 4 +log to standard error, parameters <level> +.RE +.RE +.SH "EXAMPLES" +.sp +nothing yet\&.\&. +.SH "BUGS" +.sp +Most likely there are some bugs in \fBanylike\fR\&. If you find a bug, please let the developers know at anylike@anylike\&.org\&. Of course, patches are preferred\&. +.SH "AUTHORS" +.sp +Markus Grueneis <gimpf@anylike\&.org> Christian Pointner <equinox@anylike\&.org> +.SH "RESOURCES" +.sp +Main web site: http://www\&.anylike\&.org/ +.SH "COPYING" +.sp +Copyright (C) 2009\-2010 Markus Grueneis and Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&. |