aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/world/shell.lux
blob: 0a39e0c6ab45689dd4ad849ea0b143b4fb89fc9c (plain)
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
(.using
 [library
  [lux "*"
   ["$" documentation {"+" documentation:}]
   ["@" target]
   [control
    ["<>" parser
     ["<[0]>" code]]]
   [data
    ["[0]" text {"+" \n}
     ["%" format {"+" format}]]]
   [macro
    ["[0]" template]]]]
 [\\library
  ["[0]" /]])

(documentation: /.Exit
  "A program exit code.")

(documentation: (/.Process !)
  "The means for communicating with a program/process being executed by the operating system.")

(documentation: /.Command
  "A command that can be executed by the operating system.")

(documentation: /.Argument
  "A parameter for a command.")

(documentation: (/.Shell !)
  "The means for issuing commands to the operating system.")

(documentation: (/.Mock s)
  "A simulated process.")

(documentation: /.mock
  ""
  [(mock mock init)])

(.def: .public documentation
  (.List $.Module)
  (`` (`` ($.module /._
                    ""
                    [..Exit
                     ..Process
                     ..Command
                     ..Argument
                     ..Shell
                     ..Mock
                     ..mock
                     ($.default /.normal)
                     ($.default /.error)
                     ($.default /.async)
                     (~~ (for [@.jvm (~~ (as_is ($.default /.no_more_output)
                                                ($.default /.default)))]
                              (~~ (as_is))))]
                    []))))