site/contents/reference-sys.md
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
-----
content-type: "page"
title: "sys Module"
-----
{@ _defs_.md || 0 @}
{#sig||$||get-env#}
{#alias||$||get-env#}
{#sig||\!||system#}
{#alias||\!||system#}
{#alias||\!\!||system!#}
{#sig||&||run#}
{#alias||&||run#}
{#op||.||{{null}}||{{s}}||
Returns the full path to the current directory. #}
{#op||..||{{null}}||{{s}}||
Returns the full path to the parent directory. #}
{#op||chmod||{{sl}} {{i}}||{{null}}||
> Sets the permissions of file or directory {{sl}} to {{i}}. {{i}} is a three-digit representation of user, group and other permissions. See the [Unix Permissions Calculator](http://permissions-calculator.org/) for examples and conversions.
>
> > %sidebar%
> > Example
> >
> > The following program makes the file **/tmp/test.txt** readable, writable and executable by its owner, and readable and executable by users of the same group and all other users:
> >
> > `/tmp/test.txt 755 chmod`#}
{#op||cd||{{sl}}||{{null}}||
Change the current directory to {{{sl}}. #}
{#op||cp||{{sl1}} {{sl2}}||{{null}}||
Copies the file or directory {{sl1}} to {{sl2}}. #}
{#op||cpu||{{null}}||{{s}}||
Returns the host CPU. It can be one of the following strings i386, alpha, powerpc, powerpc64, powerpc64el, sparc, amd64, mips, mipsel, arm, arm64. #}
{#op||env?||{{sl}}||{{b}}||
Returns {{t}} if environment variable {{sl}} exists, {{f}} otherwise. #}
{#op||dir?||{{sl}}||{{b}}||
Returns {{t}} if the specified path {{sl}} exists and is a directory. #}
{#op||dirname||{{sl}}||{{s}}||
Returns the path of the directory containing path {{sl}}.#}
{#op||exists?||{{sl}}||{{b}}||
Returns {{t}} if the specified file or directory {{sl}} exists. #}
{#op||file?||{{sl}}||{{b}}||
Returns {{t}} if the specified path {{sl}} exists and is a file. #}
{#op||filename||{{sl}}||{{s}}||
Returns the file name of path {{sl}}.#}
{#op||get-env||{{sl}}||{{s}}||
Returns environment variable {{sl}}. #}
{#op||hardlink||{{sl1}} {{sl2}}||{{null}}||
Creates hardlink {{sl2}} for file or directory {{sl1}}. #}
{#op||ls||{{sl}}||{{q}}||
Returns a quotation {{q}} containing all children (files and directories) of the directory {{sl}}. #}
{#op||ls-r||{{sl}}||{{q}}||
Returns a quotation {{q}} containing all children (files and directories) of the directory {{sl}}, recursively. #}
{#op||mkdir||{{sl}}||{{null}}||
Creates the specified directory {{sl}}. #}
{#op||mv||{{sl1}} {{sl2}}||{{null}}||
Moves the file or directory {{sl1}} to {{sl2}}. #}
{#op||os||{{null}}||{{s}}||
Returns the host operating system. It can be one of the following strings: windows, macosx, linux, netbsd, freebsd, openbsd, solaris, aix, standalone. #}
{#op||put-env||{{sl1}} {{sl2}}||{{s}}||
Sets environment variable {{sl2}} to {{sl1}}. #}
{#op||rm||{{sl}}||{{null}}||
Deletes the specified file {{sl}}. #}
{#op||rmdir||{{sl}}||{{null}}||
Deletes the specified directory {{sl}} and all its subdirectories recursively. #}
{#op||run||{{sl}}||{{d}}||
Executes the external command {{sl}} in the current directory without displaying its output. Returns a dictionary containing the command output and return code (in keys **output** and **code** respectively). #}
{#op||sleep||{{i}}||{{null}}||
Halts program execution for {{i}} milliseconds.#}
{#op||symlink||{{sl1}} {{sl2}}||{{null}}||
Creates symlink {{sl2}} for file or directory {{sl1}}. #}
{#op||symlink?||{{sl}}||{{b}}||
Returns {{t}} if the specified path {{sl}} exists and is a symbolic link. #}
{#op||system||{{sl}}||{{i}}||
Executes the external command {{sl}} in the current directory and pushes its return code on the stack. #}
{#op||system!||{{sl}}||{{null}}||
Executes the external command {{sl}} in the current directory without pushing its return code on the stack. #}
{#op||unzip||{{sl1}} {{sl2}}||{{null}}||
Decompresses zip file {{sl1}} to directory {{sl2}} (created if not present).#}
{#op||which||{{sl}}||{{s}}||
Returns the full path to the directory containing executable {{sl}}, or an empty string if the executable is not found in **$PATH**. #}
{#op||zip||{{sl}} {{q}}||{{null}}||
Compresses files included in quotation {{q}} into zip file {{sl}}.#}
|