Log of autodoc.git/autodoc.xml

1995-10-11

1995-10-11 11:40:40 by Fredrik Hübinette (Hubbe) <hubbe@hubbe.net>

7491fd64ecd87d062f97e698e50ffca171fd2004 (242 lines) (+233/-9) ^{[

Show
| Annotate

]}
Branch: 8.0

committing

Rev: doc/builtin/getpid:1.1
Rev: doc/builtin/kill:1.1
Rev: doc/builtin/signal:1.1
Rev: doc/builtin/signame:1.1
Rev: doc/builtin/signum:1.1
Rev: doc/builtin/sleep:1.1
Rev: doc/files/file:1.2
Rev: doc/files/port:1.2
Rev: doc/lpc/control_structures:1.2
Rev: doc/lpc/hilfe.hilfe:1.2
Rev: doc/lpc/preprocessor:1.1
Rev: doc/lpc/reserved:1.1
Rev: doc/regexp/regexp:1.2
Rev: doc/types/int:1.2

763: </tt></text></group> <group><seealso/><text> - <ref resolved='predef::fork' to='predef::fork'>files/fork</ref> and <ref to='file->pipe'>file->pipe</ref> + <ref resolved='predef::fork' to='predef::fork'>files/fork</ref> and <ref resolved='predef::/precompiled/file.pipe' to='file->pipe'>file->pipe</ref> </text></group> </doc>
1041: </text></group> <group><seealso/><text> - <ref resolved='predef::exec' to='predef::exec'>files/exec</ref> and <ref to='file->pipe'>file->pipe</ref> + <ref resolved='predef::exec' to='predef::exec'>files/exec</ref> and <ref resolved='predef::/precompiled/file.pipe' to='file->pipe'>file->pipe</ref> </text></group> </doc>
1191: </doc> </docgroup> + <docgroup homogen-name='getpid' homogen-type='method'> + <method name='getpid'/><doc placeholder='true'> + <text> + <tt>getpid</tt> - get the process id of this process + + <tt>int getpid(); + + </tt> + This returns the pid of this process. Useful for sending + signals to yourself. + </text> + + <group><seealso/><text> + <ref resolved='predef::kill' to='kill'>kill</ref>, <ref resolved='predef::fork' to='fork'>fork</ref> and <ref resolved='predef::signal' to='signal'>signal</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='hash' homogen-type='method'> <method name='hash'/><doc placeholder='true'> <text>
1268: <tt>9797 /* decimal number */ 0x20 /* hexadecimal number */ + 020 /* octal number */ </tt> This type stores an integer, normally it is 32 bits and use 4 bytes
1319: </doc> </docgroup> + <docgroup homogen-name='kill' homogen-type='method'> + <method name='kill'/><doc placeholder='true'> + <text> + <tt>kill</tt> - send signal to other process + + <tt>int kill(int pid, int signal) + + </tt> + Kill sends a signal to another process. If something goes wrong + -1 is returned, 0 otherwise. + + Some signals and their supposed purpose: + + <matrix> + <r><c> SIGHUP </c><c> Hangup, sent to process when user logs out </c></r> + <r><c> SIGINT </c><c> Interrupt, normally sent by ctrl-c </c></r> + <r><c> SIGQUIT </c><c> Quit, sent by ctrl-\ </c></r> + <r><c> SIGILL </c><c> Illegal instruction </c></r> + <r><c> SIGTRAP </c><c> Trap, mostly used by debuggers </c></r> + <r><c> SIGABRT </c><c> Aborts process, can be caught, used by uLPC whenever something goes seriously wrong. </c></r> + <r><c> SIGBUS </c><c> Bus error </c></r> + <r><c> SIGFPE </c><c> Floating point error (such as division by zero) </c></r> + <r><c> SIGKILL </c><c> Really kill a process, cannot be caught </c></r> + <r><c> SIGUSR1 </c><c> Signal reserved for whatever you want to use it for. </c></r> + <r><c> SIGSEGV </c><c> Segmentation fault, caused by accessing memory where you shouldn't. Should never happen to uLPC. </c></r> + <r><c> SIGUSR2 </c><c> Signal reserved for whatever you want to use it for. </c></r> + <r><c> SIGALRM </c><c> Signal used for timer interrupts. </c></r> + <r><c> SIGTERM </c><c> Termination signal </c></r> + <r><c> SIGSTKFLT Stack fault </c></r> + <r><c> SIGCHLD </c><c> Child process died </c></r> + <r><c> SIGCONT </c><c> Continue suspended </c></r> + <r><c> SIGSTOP </c><c> Stop process </c></r> + <r><c> SIGSTP </c><c> Suspend process </c></r> + <r><c> SIGTTIN </c><c> tty input for background process </c></r> + <r><c> SIGTTOU </c><c> tty output for background process </c></r> + <r><c> SIGXCPU </c><c> Out of cpu </c></r> + <r><c> SIGXFSZ </c><c> File size limit exceeded </c></r> + <r><c> SIGPROF </c><c> Profile trap </c></r> + <r><c> SIGWINCH Window change signal </c></r> + <r><c> Note that you have to use signame to translate the name of a signal </c></r> + <r><c> to it's number. </c></r> + </matrix> + + </text> + + <group><seealso/><text> + <ref resolved='predef::signal' to='signal'>signal</ref>, <ref resolved='predef::signum' to='signum'>signum</ref>, <ref resolved='predef::signame' to='signame'>signame</ref> and <ref resolved='predef::fork' to='predef::fork'>files/fork</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='l_sizeof' homogen-type='method'> <method name='l_sizeof'/><doc placeholder='true'> <text>
2198: </doc> </docgroup> + <docgroup homogen-name='signal' homogen-type='method'> + <method name='signal'/><doc placeholder='true'> + <text> + <tt>signal</tt> - trap signals + + <tt>void signal(int sig, function(int:void) callback); + or + void signal(int sig); + + </tt> + This function allows you to trap a signal and have a function called + when the process receives a signal. Although it IS possible to trap + SIGBUS, SIGSEGV etc. I advice you not to. uLPC should not receive any + such signals and if it does it is because of bugs in the uLPC + interperter. And all bugs should be reported, no matter how trifle. + + The callback will receive the signal number as the only argument. + See the document for the function 'kill' for a list of signals. + + If no second argument is given, the signal handler for that signal + is restored to the default handler. + </text> + + <group><seealso/><text> + <ref resolved='predef::kill' to='kill'>kill</ref>, <ref resolved='predef::signame' to='signame'>signame</ref> and <ref resolved='predef::signum' to='signum'>signum</ref> + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='signame' homogen-type='method'> + <method name='signame'/><doc placeholder='true'> + <text> + <tt>signame</tt> - get the name of a signal + + <tt>string signame(int sig); + + </tt> + Return a string describing the signal. + </text> + + <group><example/><text> + <tt>> signame(9); + Result: SIGKILL + + </tt></text></group> + + <group><seealso/><text> + <ref resolved='predef::kill' to='kill'>kill</ref>, <ref resolved='predef::signum' to='signum'>signum</ref> and <ref resolved='predef::signal' to='signal'>signal</ref> + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='signum' homogen-type='method'> + <method name='signum'/><doc placeholder='true'> + <text> + <tt>signum</tt> - get a signal number given a desctiptive string + + <tt>int signum(string sig); + + </tt> + This function is the opposite of signame. + </text> + + <group><example/><text> + <tt>> signum("SIGKILL"); + Result: 9 + + </tt></text></group> + + <group><seealso/><text> + <ref resolved='predef::signame' to='signame'>signame</ref>, <ref resolved='predef::kill' to='kill'>kill</ref> and <ref resolved='predef::signal' to='signal'>signal</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='sin' homogen-type='method'> <method name='sin'/><doc placeholder='true'> <text>
2231: </doc> </docgroup> + <docgroup homogen-name='sleep' homogen-type='method'> + <method name='sleep'/><doc placeholder='true'> + <text> + <tt>sleep</tt> - let interpreter doze of for a while + + <tt>void sleep(int s); + + </tt> + This function makes the program stop for s seconds. Only signal + handlers can interrupt the sleep. Other callbacks are not called + during sleep. + </text> + + <group><seealso/><text> + <ref resolved='predef::signal' to='signal'>signal</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='sort_array' homogen-type='method'> <method name='sort_array'/><doc placeholder='true'> <text>
2953: </tt> This funcion connects a socket previously created with - file->open_socket to a remote socket. The argument is the ip number - for the remote machine on the form x.x.x.x where x is a number. - This function returns 1 for success, 0 otherwise. Note that if the + file->open_socket to a remote socket. The argument is the ip name + or number fot he remote machine. + + This function returns 1 for success, 0 otherwise. Note that if the socket is in nonblocking mode, you have to wait for a write or close callback before you know if the connection failed or not. </text>
3108: </doc> </docgroup> + <docgroup homogen-name='pipe' homogen-type='method'> + <method name='pipe'> + </method> + <doc placeholder='true'> + <text> + <tt>pipe</tt> - create a two-way pipe + + <tt>object file->pipe(); + + </tt> + This function creates a pipe between the object it was called in + and an object that is returned. The two ends of the pipe are + indistinguishable. If the object is this function is called in + was open to begin with, it is closed before the pipe is created. + </text> + + <group><seealso/><text> + <ref resolved='predef::fork' to='predef::fork'>builtin/fork</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='query_address' homogen-type='method'> <method name='query_address'> </method>
3455: <tt>int port->bind(int port); or int port->bind(int port,function accept_callback); + or + int port->bind(int port,function accept_callback, string ip); </tt> Bind opens a sockets and binds it to port number on the local machine. If the second argument is present, the socket is set to nonblocking and the callback funcition is called whenever something connects to the socket. The callback will receive the id for this port as argument. - Bind returns 1 on success, and zero on failiure. + Bind returns 1 on success, and zero on failiure. + + If the optional argument 'ip' is given, bind will try to bind to + this ip name (or number). </text> <group><seealso/><text>
3481: or void port->create("stdin",function accept_callback) or + void port->create("stdin",function accept_callback) + or void port->create(int port) or void port->create(int port,function accept_callback) - + or + void port->create(int port,function accept_callback, string ip) </tt> When create is called with 'stdin' as argument, a socket is created
3595: /precompiled/regexp is a precompiled LPC program that interfaces a regexp package written in C. It contains a few simple functions to - handle regexps. For more documentation about regexps, consult your - unix manual for 'ed' or 'sed'. + handle regexps. A short description of regexp follows: - + . Matches any character + [abc] Matches a, b or c + [a-z] Matches any character a to z inclusive + [^ac] Matches any character except a and c + (x) Matches x (x might be any regexp) + x* Matches zero or more occurances of 'x' (x may be anything) + x|y Matches x or y. (x or y may be any regexp) + xy Matches xy (x and y may be any regexp) + ^ Matches beginning of string (but no characters) + $ Matches end of string (but no characters) + <x> Used with split() to put the string matching x into the + <dl><group><text>result array. + </text></group></dl> + + Note that \ can be used to quote these characters in which case + they match themselves, nothing else. Also note that when quoting + these something in uLPC you need two \ because uLPC also uses + this character for quoting. + + For more information about regexps, refer to your unix manuals such + as sed or ed. + Descriptions of all functions in /precompiled/file follows: 
3665: </tt> Works as regexp->match, but returns an array of the strings that - matched the subregexps. + matched the subregexps. Subregexps are those contained in < > in + the regexp. Subregexps that were not matched will contain zero. + If the total regexp didn't match, zero is returned. </text> - + <group><bugs/><text> + You can only have 40 subregexps. + </text></group> + <group><seealso/><text> <ref to='regexp->create'>regexp->create</ref> and <ref to='regexp->split'>regexp->split</ref> </text></group>

autodoc.git/ autodoc.xml

1995-10-11

1995-10-11 11:40:40 by Fredrik Hübinette (Hubbe) <hubbe@hubbe.net>