aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/world/shell.lux
blob: 7be4664409b71c45b2198954bff5be6308a624d4 (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
(.require
 [library
  [lux (.except)
   ["$" documentation]
   [data
    ["[0]" text (.only \n)
     ["%" \\format (.only format)]]]
   [meta
    ["@" target]]]]
 [\\library
  ["[0]" /]])

(def .public documentation
  (List $.Documentation)
  (`` (`` (list ($.module /._
                          "")

                ($.definition /.normal)
                ($.definition /.error)
                ($.definition /.async)
                (,, (for @.jvm (,, (these ($.definition /.no_more_output)
                                          ($.definition /.default)))
                         (,, (these))))

                ($.definition /.Exit
                  "A program exit code.")

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

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

                ($.definition /.Argument
                  "A parameter for a command.")

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

                ($.definition (/.Mock s)
                  "A simulated process.")

                ($.definition /.mock
                  ""
                  [(mock mock init)])
                ))))