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

(.def .public documentation
  (.List $.Module)
  (`` (`` ($.module /._
                    ""
                    [($.default /.normal)
                     ($.default /.error)
                     ($.default /.async)
                     (,, (for @.jvm (,, (these ($.default /.no_more_output)
                                               ($.default /.default)))
                              (,, (these))))

                     ($.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)])]
                    []))))