updated the API docs and added some links
This commit is contained in:
parent
110c3e5886
commit
3e15ffa6ed
14
docs/api.md
14
docs/api.md
@ -27,6 +27,10 @@ Returns true or false if *pass* is the correct password for *user*.
|
||||
Generates *len* random printable characters and returns them.
|
||||
#### os.su(*user*,*pass*)
|
||||
Sets the user ID of the current process to *user* if *user* and *password* are verified by `os.verifyuser`.
|
||||
#### os.setuattr(*user*,*field*,*value*)
|
||||
Sets the *field* attribute of *user* to *value*.
|
||||
#### os.getuattr(*user*,*field*)
|
||||
Returns the value of *field* for *user*.
|
||||
|
||||
### event
|
||||
#### event.get()
|
||||
@ -97,6 +101,8 @@ Writes *data* to *fobj* (if in write mode)
|
||||
Closes *fobj*, flushing buffers and removing the object from memory.
|
||||
|
||||
### shutil
|
||||
#### exec(*command*)
|
||||
Executes *command* as if it had been typed into a shell (lush, specifically).
|
||||
#### cd(*path*)
|
||||
Alias to fs.cd
|
||||
#### rm(*path*)
|
||||
@ -159,8 +165,12 @@ This is triggered to make a tty driver attached to *session* write *text* to the
|
||||
|
||||
|
||||
## Applications
|
||||
### luash(*sI*)
|
||||
Spawns a luash instance for session *sI*
|
||||
### login()
|
||||
Displays a login screen allowing for changing user.
|
||||
### loginmanager(*sI*)
|
||||
Runs a program that will repeatedly display a login screen and spawn a shell on login.
|
||||
### lush(*sI*)
|
||||
Spawns a lush instance for session *sI*
|
||||
### skex(*fname*)
|
||||
Launches an instance of the skex text editor, optionally reading *fname* at startup.
|
||||
May actually spawn skex2.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## PsychOS
|
||||
|
||||
PsychOS is a single-user cooperative multitasking operating system for OpenComputers.
|
||||
PsychOS is a multi-user cooperative multitasking operating system for OpenComputers.
|
||||
|
||||
### System requirements:
|
||||
|
||||
@ -24,3 +24,9 @@ PsychOS is a single-user cooperative multitasking operating system for OpenCompu
|
||||
- [Building PsychOS](building.html)
|
||||
- [API documentation](api.html)
|
||||
- [Filesystem layout](fhs.html)
|
||||
|
||||
### Sources and contributing
|
||||
|
||||
PsychOS has its [source code on GitHub](https://github.com/XeonSquared/PsychOS) and is open to pull requests, bug reports and other forms of contribution.
|
||||
|
||||
In addition, some [extra PsychOS related projects](https://git.shadowkat.net/izaya/psychos-programs) can be found on the [SKS Gogs](https://shadowkat.net) instance
|
||||
|
Loading…
Reference in New Issue
Block a user