Module irccd.system

System information.

Inspect the current operating system.

Functions

env () Get a environment variable.
home () Get the home directory.
name () Get the operating system name.
ticks () Get the time spent from start.
sleep (sec) Sleep for seconds.
uptime () Get the system uptime.
usleep (msec) Sleep for milliseconds.
version () Get the operating system version.


Functions

env ()
Get a environment variable.

Returns:

    the variable or an empty string
home ()
Get the home directory. This function should be used with care, plugin should not use user home to store files.

Returns:

    the user home directory

See also:

name ()
Get the operating system name. Usually Windows, FreeBSD, Linux and such.

Returns:

    the system name
ticks ()
Get the time spent from start. Get how many milliseconds spent since the irccd startup.

Returns:

    the number of seconds
sleep (sec)
Sleep for seconds. Suspend the execution thread.

Parameters:

  • sec the number of seconds

See also:

uptime ()
Get the system uptime. This function returns the number of seconds elapsed since the system boot up.

Returns:

    the number of seconds
usleep (msec)
Sleep for milliseconds. Suspend the execution thread.

Parameters:

  • msec the number of milliseconds

See also:

version ()
Get the operating system version. This function is completely system dependent.

Returns:

    the version as a string
generated by LDoc 1.4.0