Mercurial > irccd

view doc/src/js/module/Irccd.System/Irccd.System.popen.md @ 817:ebe561276c33

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: start reworking, continue #752 @8h
author David Demelier <markand@malikania.fr>
date Mon, 19 Nov 2018 07:04:42 +0100
parents doc/src/api/module/Irccd.System/Irccd.System.popen.md@ebdc614db066
children
line wrap: on
line source

# Function Irccd.System.popen

Wrapper for `popen(3)` if the function is available.

**Note**: this function is optional and may not be available on your system.

# Synopsis

```javascript
Irccd.System.popen(cmd, mode) /* optional */
```

# Arguments

- cmd: the command to execute,
- mode: the mode (e.g. `r`).

# Returns

An [Irccd.File](#{baseurl}api/module/Irccd.File/index.html) object.

# Throws

An [Irccd.SystemError](#{baseurl}api/module/Irccd/index.html#types) on failures.