Mercurial > irccd

comparison 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
comparison
equal deleted inserted replaced
816:42992b30f928 817:ebe561276c33
1 # Function Irccd.System.popen
2
3 Wrapper for `popen(3)` if the function is available.
4
5 **Note**: this function is optional and may not be available on your system.
6
7 # Synopsis
8
9 ```javascript
10 Irccd.System.popen(cmd, mode) /* optional */
11 ```
12
13 # Arguments
14
15 - cmd: the command to execute,
16 - mode: the mode (e.g. `r`).
17
18 # Returns
19
20 An [Irccd.File](#{baseurl}api/module/Irccd.File/index.html) object.
21
22 # Throws
23
24 An [Irccd.SystemError](#{baseurl}api/module/Irccd/index.html#types) on failures.