diff options
| author | Thijs Schreijer <thijs@thijsschreijer.nl> | 2023-11-09 23:03:21 +0100 |
|---|---|---|
| committer | Thijs Schreijer <thijs@thijsschreijer.nl> | 2023-11-15 19:17:57 +0100 |
| commit | d45768de3e6f7b28bfecf4d19b192ccac9ce5dc2 (patch) | |
| tree | 2d4f86ec87eb87a77f6663924aaaa9286756ce3e /doc_topics | |
| parent | d4222ce6da2a2d7179fc79f9d0cc65fd6c09a686 (diff) | |
| download | luasystem-d45768de3e6f7b28bfecf4d19b192ccac9ce5dc2.tar.gz luasystem-d45768de3e6f7b28bfecf4d19b192ccac9ce5dc2.tar.bz2 luasystem-d45768de3e6f7b28bfecf4d19b192ccac9ce5dc2.zip | |
feat(*): add environment variable and random functions
Diffstat (limited to 'doc_topics')
| -rw-r--r-- | doc_topics/01-introduction.md | 12 | ||||
| -rw-r--r-- | doc_topics/ldoc.css | 291 |
2 files changed, 303 insertions, 0 deletions
diff --git a/doc_topics/01-introduction.md b/doc_topics/01-introduction.md new file mode 100644 index 0000000..9cc2347 --- /dev/null +++ b/doc_topics/01-introduction.md | |||
| @@ -0,0 +1,12 @@ | |||
| 1 | # 1. Introduction | ||
| 2 | |||
| 3 | luasystem is a platform independent system call library for Lua. | ||
| 4 | Supports Unix, Windows, MacOS, `Lua >= 5.1` and `luajit >= 2.0.0`. | ||
| 5 | |||
| 6 | Lua is typically platform independent, but it requires adhering to very old C | ||
| 7 | standards. This in turn means that many common features (according to todays standards) | ||
| 8 | are not available. This module attempts to overcome some of those hurdles by providing | ||
| 9 | functions that cover those common needs. | ||
| 10 | |||
| 11 | This is not a kitchen sink library, but a minimalistic one with a focus on platform | ||
| 12 | independence. | ||
diff --git a/doc_topics/ldoc.css b/doc_topics/ldoc.css new file mode 100644 index 0000000..5b9fbbf --- /dev/null +++ b/doc_topics/ldoc.css | |||
| @@ -0,0 +1,291 @@ | |||
| 1 | body { | ||
| 2 | color: #47555c; | ||
| 3 | font-size: 16px; | ||
| 4 | font-family: "Open Sans", sans-serif; | ||
| 5 | margin: 0; | ||
| 6 | background: #eff4ff; | ||
| 7 | } | ||
| 8 | |||
| 9 | a:link { color: #008fee; } | ||
| 10 | a:visited { color: #008fee; } | ||
| 11 | a:hover { color: #22a7ff; } | ||
| 12 | |||
| 13 | h1 { font-size:26px; font-weight: normal; } | ||
| 14 | h2 { font-size:22px; font-weight: normal; } | ||
| 15 | h3 { font-size:18px; font-weight: normal; } | ||
| 16 | h4 { font-size:16px; font-weight: bold; } | ||
| 17 | |||
| 18 | hr { | ||
| 19 | height: 1px; | ||
| 20 | background: #c1cce4; | ||
| 21 | border: 0px; | ||
| 22 | margin: 15px 0; | ||
| 23 | } | ||
| 24 | |||
| 25 | code, tt { | ||
| 26 | font-family: monospace; | ||
| 27 | } | ||
| 28 | span.parameter { | ||
| 29 | font-family: monospace; | ||
| 30 | font-weight: bold; | ||
| 31 | color: rgb(99, 115, 131); | ||
| 32 | } | ||
| 33 | span.parameter:after { | ||
| 34 | content:":"; | ||
| 35 | } | ||
| 36 | span.types:before { | ||
| 37 | content:"("; | ||
| 38 | } | ||
| 39 | span.types:after { | ||
| 40 | content:")"; | ||
| 41 | } | ||
| 42 | .type { | ||
| 43 | font-weight: bold; font-style:italic | ||
| 44 | } | ||
| 45 | |||
| 46 | p.name { | ||
| 47 | font-family: "Andale Mono", monospace; | ||
| 48 | } | ||
| 49 | |||
| 50 | #navigation { | ||
| 51 | float: left; | ||
| 52 | background-color: white; | ||
| 53 | border-right: 1px solid #d3dbec; | ||
| 54 | border-bottom: 1px solid #d3dbec; | ||
| 55 | |||
| 56 | width: 14em; | ||
| 57 | vertical-align: top; | ||
| 58 | overflow: visible; | ||
| 59 | } | ||
| 60 | |||
| 61 | #navigation br { | ||
| 62 | display: none; | ||
| 63 | } | ||
| 64 | |||
| 65 | #navigation h1 { | ||
| 66 | background-color: white; | ||
| 67 | border-bottom: 1px solid #d3dbec; | ||
| 68 | padding: 15px; | ||
| 69 | margin-top: 0px; | ||
| 70 | margin-bottom: 0px; | ||
| 71 | } | ||
| 72 | |||
| 73 | #navigation h2 { | ||
| 74 | font-size: 18px; | ||
| 75 | background-color: white; | ||
| 76 | border-bottom: 1px solid #d3dbec; | ||
| 77 | padding-left: 15px; | ||
| 78 | padding-right: 15px; | ||
| 79 | padding-top: 10px; | ||
| 80 | padding-bottom: 10px; | ||
| 81 | margin-top: 30px; | ||
| 82 | margin-bottom: 0px; | ||
| 83 | } | ||
| 84 | |||
| 85 | #content h1 { | ||
| 86 | background-color: #2c3e67; | ||
| 87 | color: white; | ||
| 88 | padding: 15px; | ||
| 89 | margin: 0px; | ||
| 90 | } | ||
| 91 | |||
| 92 | #content h2 { | ||
| 93 | background-color: #6c7ea7; | ||
| 94 | color: white; | ||
| 95 | padding: 15px; | ||
| 96 | padding-top: 15px; | ||
| 97 | padding-bottom: 15px; | ||
| 98 | margin-top: 0px; | ||
| 99 | } | ||
| 100 | |||
| 101 | #content h2 a { | ||
| 102 | background-color: #6c7ea7; | ||
| 103 | color: white; | ||
| 104 | text-decoration: none; | ||
| 105 | } | ||
| 106 | |||
| 107 | #content h2 a:hover { | ||
| 108 | text-decoration: underline; | ||
| 109 | } | ||
| 110 | |||
| 111 | #content h3 { | ||
| 112 | font-style: italic; | ||
| 113 | padding-top: 15px; | ||
| 114 | padding-bottom: 4px; | ||
| 115 | margin-right: 15px; | ||
| 116 | margin-left: 15px; | ||
| 117 | margin-bottom: 5px; | ||
| 118 | border-bottom: solid 1px #bcd; | ||
| 119 | } | ||
| 120 | |||
| 121 | #content h4 { | ||
| 122 | margin-right: 15px; | ||
| 123 | margin-left: 15px; | ||
| 124 | border-bottom: solid 1px #bcd; | ||
| 125 | } | ||
| 126 | |||
| 127 | #content pre { | ||
| 128 | margin: 15px; | ||
| 129 | } | ||
| 130 | |||
| 131 | pre { | ||
| 132 | background-color: rgb(50, 55, 68); | ||
| 133 | color: white; | ||
| 134 | border-radius: 3px; | ||
| 135 | /* border: 1px solid #C0C0C0; /* silver */ | ||
| 136 | padding: 15px; | ||
| 137 | overflow: auto; | ||
| 138 | font-family: "Andale Mono", monospace; | ||
| 139 | } | ||
| 140 | |||
| 141 | #content ul pre.example { | ||
| 142 | margin-left: 0px; | ||
| 143 | } | ||
| 144 | |||
| 145 | table.index { | ||
| 146 | /* border: 1px #00007f; */ | ||
| 147 | } | ||
| 148 | table.index td { text-align: left; vertical-align: top; } | ||
| 149 | |||
| 150 | #navigation ul | ||
| 151 | { | ||
| 152 | font-size:1em; | ||
| 153 | list-style-type: none; | ||
| 154 | margin: 1px 1px 10px 1px; | ||
| 155 | padding-left: 20px; | ||
| 156 | } | ||
| 157 | |||
| 158 | #navigation li { | ||
| 159 | text-indent: -1em; | ||
| 160 | display: block; | ||
| 161 | margin: 3px 0px 0px 22px; | ||
| 162 | } | ||
| 163 | |||
| 164 | #navigation li li a { | ||
| 165 | margin: 0px 3px 0px -1em; | ||
| 166 | } | ||
| 167 | |||
| 168 | #content { | ||
| 169 | margin-left: 14em; | ||
| 170 | } | ||
| 171 | |||
| 172 | #content p { | ||
| 173 | padding-left: 15px; | ||
| 174 | padding-right: 15px; | ||
| 175 | } | ||
| 176 | |||
| 177 | #content table { | ||
| 178 | padding-left: 15px; | ||
| 179 | padding-right: 15px; | ||
| 180 | background-color: white; | ||
| 181 | } | ||
| 182 | |||
| 183 | #content p, #content table, #content ol, #content ul, #content dl { | ||
| 184 | max-width: 900px; | ||
| 185 | } | ||
| 186 | |||
| 187 | #about { | ||
| 188 | padding: 15px; | ||
| 189 | padding-left: 16em; | ||
| 190 | background-color: white; | ||
| 191 | border-top: 1px solid #d3dbec; | ||
| 192 | border-bottom: 1px solid #d3dbec; | ||
| 193 | } | ||
| 194 | |||
| 195 | table.module_list, table.function_list { | ||
| 196 | border-width: 1px; | ||
| 197 | border-style: solid; | ||
| 198 | border-color: #cccccc; | ||
| 199 | border-collapse: collapse; | ||
| 200 | margin: 15px; | ||
| 201 | } | ||
| 202 | table.module_list td, table.function_list td { | ||
| 203 | border-width: 1px; | ||
| 204 | padding-left: 10px; | ||
| 205 | padding-right: 10px; | ||
| 206 | padding-top: 5px; | ||
| 207 | padding-bottom: 5px; | ||
| 208 | border: solid 1px rgb(193, 204, 228); | ||
| 209 | } | ||
| 210 | table.module_list td.name, table.function_list td.name { | ||
| 211 | background-color: white; min-width: 200px; border-right-width: 0px; | ||
| 212 | } | ||
| 213 | table.module_list td.summary, table.function_list td.summary { | ||
| 214 | background-color: white; width: 100%; border-left-width: 0px; | ||
| 215 | } | ||
| 216 | |||
| 217 | dl.function { | ||
| 218 | margin-right: 15px; | ||
| 219 | margin-left: 15px; | ||
| 220 | border-bottom: solid 1px rgb(193, 204, 228); | ||
| 221 | border-left: solid 1px rgb(193, 204, 228); | ||
| 222 | border-right: solid 1px rgb(193, 204, 228); | ||
| 223 | background-color: white; | ||
| 224 | } | ||
| 225 | |||
| 226 | dl.function dt { | ||
| 227 | color: rgb(99, 123, 188); | ||
| 228 | font-family: monospace; | ||
| 229 | border-top: solid 1px rgb(193, 204, 228); | ||
| 230 | padding: 15px; | ||
| 231 | } | ||
| 232 | |||
| 233 | dl.function dd { | ||
| 234 | margin-left: 15px; | ||
| 235 | margin-right: 15px; | ||
| 236 | margin-top: 5px; | ||
| 237 | margin-bottom: 15px; | ||
| 238 | } | ||
| 239 | |||
| 240 | #content dl.function dd h3 { | ||
| 241 | margin-top: 0px; | ||
| 242 | margin-left: 0px; | ||
| 243 | padding-left: 0px; | ||
| 244 | font-size: 16px; | ||
| 245 | color: rgb(128, 128, 128); | ||
| 246 | border-bottom: solid 1px #def; | ||
| 247 | } | ||
| 248 | |||
| 249 | #content dl.function dd ul, #content dl.function dd ol { | ||
| 250 | padding: 0px; | ||
| 251 | padding-left: 15px; | ||
| 252 | list-style-type: none; | ||
| 253 | } | ||
| 254 | |||
| 255 | ul.nowrap { | ||
| 256 | overflow:auto; | ||
| 257 | white-space:nowrap; | ||
| 258 | } | ||
| 259 | |||
| 260 | .section-description { | ||
| 261 | padding-left: 15px; | ||
| 262 | padding-right: 15px; | ||
| 263 | } | ||
| 264 | |||
| 265 | /* stop sublists from having initial vertical space */ | ||
| 266 | ul ul { margin-top: 0px; } | ||
| 267 | ol ul { margin-top: 0px; } | ||
| 268 | ol ol { margin-top: 0px; } | ||
| 269 | ul ol { margin-top: 0px; } | ||
| 270 | |||
| 271 | /* make the target distinct; helps when we're navigating to a function */ | ||
| 272 | a:target + * { | ||
| 273 | background-color: #FF9; | ||
| 274 | } | ||
| 275 | |||
| 276 | |||
| 277 | /* styles for prettification of source */ | ||
| 278 | pre .comment { color: #bbccaa; } | ||
| 279 | pre .constant { color: #a8660d; } | ||
| 280 | pre .escape { color: #844631; } | ||
| 281 | pre .keyword { color: #ffc090; font-weight: bold; } | ||
| 282 | pre .library { color: #0e7c6b; } | ||
| 283 | pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } | ||
| 284 | pre .string { color: #8080ff; } | ||
| 285 | pre .number { color: #f8660d; } | ||
| 286 | pre .operator { color: #2239a8; font-weight: bold; } | ||
| 287 | pre .preprocessor, pre .prepro { color: #a33243; } | ||
| 288 | pre .global { color: #c040c0; } | ||
| 289 | pre .user-keyword { color: #800080; } | ||
| 290 | pre .prompt { color: #558817; } | ||
| 291 | pre .url { color: #272fc2; text-decoration: underline; } | ||
