mirror of git://git.psyced.org/git/psyclpc
324 lines
9.1 KiB
Groff
324 lines
9.1 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
|
|
.TH PSYCLPC "1" "May 2011" "psyclpc 4.0.14 - a multi-protocol network server application language." "User Commands"
|
|
.SH NAME
|
|
psyclpc \- psyclpc
|
|
.SH SYNOPSIS
|
|
.B psyclpc
|
|
[\fIoptions\fR] [\fI<portnumber>\fR...]
|
|
.SH DESCRIPTION
|
|
psyclpc 4.0.14 \- a multi\-protocol network server application language.
|
|
.PP
|
|
Release: Build 2483 (stable); 2009\-01\-12
|
|
Compiled: May 10 2011 00:51:18
|
|
.PP
|
|
Options are:
|
|
.HP
|
|
\fB\-\-args\fR <filename>
|
|
.IP
|
|
Read the options from <filename> as if they were given on the
|
|
commandline.
|
|
.HP
|
|
\fB\-P\fR|\-\-inherit <fd\-number>
|
|
.IP
|
|
Inherit filedescriptor <fd\-number> from the parent process
|
|
as socket to listen for connections.
|
|
.HP
|
|
\fB\-u\fR|\-\-udp <portnumber>
|
|
.IP
|
|
Specify the <portnumber> for the UDP port, overriding the compiled\-in
|
|
default.
|
|
.HP
|
|
\fB\-D\fR|\-\-define <macro>[=<text>]
|
|
.IP
|
|
Add <macro> (optionally to be expanded to <text>) to the list of
|
|
predefined macros known by the LPC compiler.
|
|
.HP
|
|
\fB\-E\fR|\-\-eval\-cost <ticks>
|
|
.IP
|
|
Set the number of <ticks> available for one evaluation thread.
|
|
.HP
|
|
\fB\-M\fR|\-\-master <filename>
|
|
.IP
|
|
Use <filename> for the master object.
|
|
.HP
|
|
\fB\-m\fR|\-\-mudlib <pathname>
|
|
.IP
|
|
Use <pathname> as the top directory of the library.
|
|
.HP
|
|
\fB\-\-debug\-file\fR <filename>
|
|
.IP
|
|
This function has been disabled at compile time.
|
|
Please remove it from your scripts.
|
|
.HP
|
|
\fB\-\-hostname\fR <name>
|
|
.IP
|
|
Use <name> as hostname, instead of what the system says.
|
|
.HP
|
|
\fB\-\-hostaddr\fR <addr>
|
|
.IP
|
|
Use <addr> as address of this machine, instead of what the
|
|
system says. In particular this address will be used to open
|
|
the driver ports.
|
|
.HP
|
|
\fB\-\-compat\fR
|
|
.HP
|
|
\fB\-\-no\-compat\fR
|
|
.IP
|
|
Select the mode (compat or plain) of the driver.
|
|
Note that this choice does not affect the default name of the master
|
|
object.
|
|
.HP
|
|
\fB\-d\fR|\-\-debug
|
|
.IP
|
|
Generate debug output; repeat the argument for even more output.
|
|
.HP
|
|
\fB\-c\fR|\-\-list\-compiles
|
|
.IP
|
|
List the name of every compiled file on stderr.
|
|
.HP
|
|
\fB\-e\fR|\-\-no\-preload
|
|
.IP
|
|
Pass a non\-zero argument (the number of occurences of this option)
|
|
to master\->preload(), which usually inhibits all preloads of castles
|
|
and other objects.
|
|
.HP
|
|
\fB\-\-erq\fR <filename>
|
|
.HP
|
|
\fB\-\-erq\fR "<filename> <erq arguments>"
|
|
.IP
|
|
Use <filename> instead of 'erq' as the name of the ERQ executable.
|
|
If the name starts with a '/', it is take to be an absolute pathname,
|
|
otherwise it is interpreted relative to /opt/psyced/bin.
|
|
If not specified, 'erq' is used as executable name.
|
|
With the proper use of quotes it is legal to pass arbitrary arguments
|
|
to the erq, however, these may not contain spaces themselves.
|
|
.HP
|
|
\fB\-N\fR|\-\-no\-erq
|
|
.IP
|
|
Don't start the erq demon (if it would be started at all).
|
|
.HP
|
|
\fB\-\-alarm\-time\fR <time>
|
|
.IP
|
|
The granularity of call_out()s and heartbeats (minimum: 1).
|
|
.HP
|
|
\fB\-\-heart\-interval\fR <time>
|
|
.IP
|
|
The time to elapse between two heartbeats (minimum: 1).
|
|
.HP
|
|
\fB\-\-sync\-heart\fR
|
|
.IP
|
|
All heartbeats are executed at the same time (modulo granularity).
|
|
.HP
|
|
\fB\-\-async\-heart\fR
|
|
.IP
|
|
Heartbeats are executed immediately when they are due (modulo granularity).
|
|
.HP
|
|
\fB\-t\fR|\-\-no\-heart
|
|
.IP
|
|
Disable heartbeats and call_outs.
|
|
.HP
|
|
\fB\-f\fR|\-\-funcall <word>
|
|
.IP
|
|
The lfun master\->flag() is called with <word> as argument before the
|
|
gamedriver accepts network connections.
|
|
.HP
|
|
\fB\-\-cleanup\-time\fR <time>
|
|
.IP
|
|
The idle time in seconds for an object before the driver tries to
|
|
clean it up. This time should be substantially higher than the
|
|
reset time. A time <= 0 disables the cleanup mechanism.
|
|
.HP
|
|
\fB\-\-reset\-time\fR <time>
|
|
.IP
|
|
The time in seconds for an object before it is reset.
|
|
A time <= 0 disables the reset mechanism.
|
|
.HP
|
|
\fB\-\-regexp\fR pcre|traditional
|
|
.IP
|
|
Select the default regexp package.
|
|
.HP
|
|
\fB\-\-max\-array\fR <size>
|
|
.IP
|
|
The maximum number of elements an array can hold.
|
|
Set to 0, arrays of any size are allowed.
|
|
.HP
|
|
\fB\-\-max\-callouts\fR <number>
|
|
.IP
|
|
The maximum number of callouts at one time.
|
|
Set to 0, any number of callouts is allowed.
|
|
.HP
|
|
\fB\-\-max\-mapping\fR <size>
|
|
.IP
|
|
The maximum number of elements (keys+values) a mapping can hold.
|
|
Set to 0, mappings of any size are allowed.
|
|
.HP
|
|
\fB\-\-max\-mapping\-keys\fR <size>
|
|
.IP
|
|
The maximum number of entries (keys) a mapping can hold.
|
|
Set to 0, mappings of any size are allowed.
|
|
.HP
|
|
\fB\-\-max\-bytes\fR <size>
|
|
.IP
|
|
The maximum number of bytes one read_bytes()/write_bytes() call
|
|
can handle.
|
|
Set to 0, reads and writes of any size are allowed.
|
|
.HP
|
|
\fB\-\-max\-file\fR <size>
|
|
.IP
|
|
The maximum number of bytes one read_file()/write_file() call
|
|
can handle.
|
|
Set to 0, reads and writes of any size are allowed.
|
|
.HP
|
|
\fB\-\-max\-thread\-pending\fR <size>
|
|
.IP
|
|
The maximum number of bytes to be kept pending by the socket write
|
|
thread.
|
|
Set to 0, an unlimited amount of data can be kept pending.
|
|
(Ignored since pthreads are not supported)
|
|
.TP
|
|
\fB\-s\fR <time>
|
|
| \fB\-\-swap\-time\fR <time>
|
|
.HP
|
|
\fB\-s\fR v<time> | \fB\-\-swap\-variables\fR <time>
|
|
.IP
|
|
Time in seconds before an object (or its variables) are swapped out.
|
|
A time less or equal 0 disables swapping.
|
|
.HP
|
|
\fB\-s\fR f<name> | \fB\-\-swap\-file\fR <name>
|
|
.IP
|
|
Swap into file <name> instead of log/psyced.swap.<host> .
|
|
.HP
|
|
\fB\-s\fR c | \fB\-\-swap\-compact\fR
|
|
.IP
|
|
Reuse free space in the swap file immediately.
|
|
.HP
|
|
\fB\-\-max\-malloc\fR <size>
|
|
.IP
|
|
Restrict total memory allocations to <size> bytes. A <size> of 0
|
|
or 'unlimited' removes any restriction.
|
|
.HP
|
|
\fB\-\-min\-malloc\fR <size>
|
|
.HP
|
|
\fB\-\-min\-small\-malloc\fR <size>
|
|
.IP
|
|
Determine the sizes for the explicite initial large resp. small chunk
|
|
allocation. A size of 0 disables the explicite initial allocations.
|
|
.HP
|
|
\fB\-r\fR u<size> | \fB\-\-reserve\-user\fR <size>
|
|
.HP
|
|
\fB\-r\fR m<size> | \fB\-\-reserve\-master\fR <size>
|
|
.HP
|
|
\fB\-r\fR s<size> | \fB\-\-reserve\-system\fR <size>
|
|
.IP
|
|
Reserve <size> amount of memory for user/master/system allocations to
|
|
be held until main memory runs out.
|
|
.HP
|
|
\fB\-\-filename\-spaces\fR
|
|
.HP
|
|
\fB\-\-no\-filename\-spaces\fR
|
|
.IP
|
|
Allow/disallow the use of spaces in filenames.
|
|
.HP
|
|
\fB\-\-strict\-euids\fR
|
|
.HP
|
|
\fB\-\-no\-strict\-euids\fR
|
|
.IP
|
|
Enforce/don't enforce the proper use of euids.
|
|
.HP
|
|
\fB\-\-share\-variables\fR
|
|
.HP
|
|
\fB\-\-init\-variables\fR
|
|
.IP
|
|
Select how clones initialize their variables:
|
|
.IP
|
|
\- by sharing the current values of their blueprint
|
|
\- by initializing them afresh (using __INIT()).
|
|
.HP
|
|
\fB\-\-tls\-key\fR <pathname>
|
|
.IP
|
|
Use <pathname> as the x509 keyfile, default is 'key.pem'.
|
|
If relative, <pathname> is interpreted relative to <mudlib>.
|
|
.HP
|
|
\fB\-\-tls\-cert\fR <pathname>
|
|
.IP
|
|
Use <pathname> as the x509 certfile, default is 'cert.pem'.
|
|
If relative, <pathname> is interpreted relative to <mudlib>.
|
|
.IP
|
|
Use <pathname> as the filename holding your trusted PEM certificates.
|
|
If relative, <pathname> is interpreted relative to <mudlib>.
|
|
.IP
|
|
Use <pathname> as the directory where your trusted PEM certificates reside,
|
|
default is '/etc/ssl/certs'.
|
|
If relative, <pathname> is interpreted relative to <mudlib>.
|
|
.IP
|
|
Use <pathname> as the filename holding your certificate revocation lists.
|
|
If relative, <pathname> is interpreted relative to <mudlib>.
|
|
.IP
|
|
Use <pathname> as the directory where your certificate revocation lists reside.
|
|
If relative, <pathname> is interpreted relative to <mudlib>.
|
|
.IP
|
|
Use <pathname> as the filename holding your certificate revocation lists.
|
|
If relative, <pathname> is interpreted relative to <mudlib>.
|
|
.IP
|
|
Use <pathname> as the directory where your certificate revocation lists reside.
|
|
If relative, <pathname> is interpreted relative to <mudlib>.
|
|
.HP
|
|
\fB\-\-wizlist\-file\fR <filename>
|
|
.HP
|
|
\fB\-\-no\-wizlist\-file\fR
|
|
.IP
|
|
Read and save the wizlist in the named file (always interpreted
|
|
relative to the mudlib); resp. don't read or save the wizlist.
|
|
.HP
|
|
\fB\-\-pidfile\fR <filename>
|
|
.IP
|
|
Write the pid of the driver process into <filename>.
|
|
.HP
|
|
\fB\-\-randomdevice\fR <filename>
|
|
.IP
|
|
Determines the source of the seed for the random number generator.
|
|
(tries /dev/urandom by default and uses system clock as fallback)
|
|
.HP
|
|
\fB\-\-random\-seed\fR <num>
|
|
.IP
|
|
Seed value for the random number generator. If not given, the
|
|
driver chooses a seed value on its own.
|
|
.HP
|
|
\fB\-\-options\fR
|
|
.IP
|
|
Print the version and compilation options of the driver, then exit.
|
|
.HP
|
|
\fB\-V\fR|\-\-version
|
|
.IP
|
|
Print the version of the driver, then exit.
|
|
.HP
|
|
\fB\-\-longhelp\fR
|
|
.IP
|
|
Display this help and exit.
|
|
.HP
|
|
\fB\-h\fR|\-?|\-\-help
|
|
.IP
|
|
Display the short help text and exit.
|
|
.PP
|
|
Release: Build 2483 (stable); 2009\-01\-12
|
|
Compiled: May 10 2011 00:51:18
|
|
.SH CONTACT
|
|
psyclpc is being maintained by fippo & lynX.
|
|
|
|
fippo is available at psyc://goodadvice.pages.de/~fippo
|
|
or xmpp:fippo@goodadvice.pages.de
|
|
|
|
lynX is available as psyc://psyced.org/~lynx
|
|
|
|
You can reach us at psyc://psyced.org/@welcome
|
|
.SH HISTORY
|
|
psyclpc is a programming language for intense multi-user network applications
|
|
such as psyced. it's a recent fork of LDMud with some features and many
|
|
bug fixes. we kept it compatible to LDMud, so you can run a MUD with it, too.
|
|
It is available from <http://lpc.psyc.eu>.
|
|
|
|
LDMud itself is a continuation of the Amylaar LPMud Gamedriver 3.1.2.
|
|
See also <http://www.bearnip.com/lars/proj/ldmud.html>.
|
|
|
|
psyclpc is released under the GNU LIBRARY GENERAL PUBLIC LICENSE, Version 2.
|