doc update/command synopses

This commit is contained in:
minjaesong
2026-06-06 21:59:18 +09:00
parent df16b99ba5
commit 3444bdf63b
49 changed files with 2145 additions and 69 deletions

View File

@@ -0,0 +1,12 @@
{
"tsfVersion": "1.0",
"name": "cat",
"summary": "Print a file, or pipe its contents onward",
"symbols": {
"file": { "kind": "positional", "type": "file", "name": "FILE", "summary": "File to read; reads from the pipe when omitted" }
},
"synopsis": {
"type": "optional",
"child": { "type": "reference", "symbol": "file" }
}
}

View File

@@ -0,0 +1,12 @@
{
"tsfVersion": "1.0",
"name": "cd",
"summary": "Change the current working directory",
"symbols": {
"dir": { "kind": "positional", "type": "directory", "name": "DIR", "summary": "Directory to change into; prints the current directory when omitted" }
},
"synopsis": {
"type": "optional",
"child": { "type": "reference", "symbol": "dir" }
}
}

View File

@@ -0,0 +1,22 @@
{
"tsfVersion": "1.0",
"name": "chvt",
"summary": "Switch to virtual console N (1-6)",
"symbols": {
"console": {
"kind": "positional",
"type": "enum",
"name": "N",
"summary": "Target virtual console",
"values": [
{ "value": "1", "summary": "Virtual console 1" },
{ "value": "2", "summary": "Virtual console 2" },
{ "value": "3", "summary": "Virtual console 3" },
{ "value": "4", "summary": "Virtual console 4" },
{ "value": "5", "summary": "Virtual console 5" },
{ "value": "6", "summary": "Virtual console 6" }
]
}
},
"synopsis": { "type": "reference", "symbol": "console" }
}

View File

@@ -0,0 +1,7 @@
{
"tsfVersion": "1.0",
"name": "cls",
"summary": "Clear the screen",
"symbols": {},
"synopsis": { "type": "sequence", "children": [] }
}

View File

@@ -0,0 +1,16 @@
{
"tsfVersion": "1.0",
"name": "cp",
"summary": "Copy a file",
"symbols": {
"source": { "kind": "positional", "type": "file", "name": "SOURCE", "summary": "File to copy from" },
"dest": { "kind": "positional", "type": "path", "name": "DEST", "summary": "Destination path" }
},
"synopsis": {
"type": "sequence",
"children": [
{ "type": "reference", "symbol": "source" },
{ "type": "reference", "symbol": "dest" }
]
}
}

View File

@@ -0,0 +1,7 @@
{
"tsfVersion": "1.0",
"name": "date",
"summary": "Print the system date and time",
"symbols": {},
"synopsis": { "type": "sequence", "children": [] }
}

View File

@@ -0,0 +1,9 @@
{
"tsfVersion": "1.0",
"name": "del",
"summary": "Delete a file",
"symbols": {
"file": { "kind": "positional", "type": "file", "name": "FILE", "summary": "File to delete" }
},
"synopsis": { "type": "reference", "symbol": "file" }
}

View File

@@ -0,0 +1,12 @@
{
"tsfVersion": "1.0",
"name": "dir",
"summary": "List the contents of a directory",
"symbols": {
"path": { "kind": "positional", "type": "directory", "name": "PATH", "summary": "Directory to list; the working directory when omitted" }
},
"synopsis": {
"type": "optional",
"child": { "type": "reference", "symbol": "path" }
}
}

View File

@@ -0,0 +1,12 @@
{
"tsfVersion": "1.0",
"name": "echo",
"summary": "Print text, expanding $VARIABLE references",
"symbols": {
"text": { "kind": "positional", "type": "string", "name": "TEXT", "summary": "Text to print", "completion": { "method": "none" } }
},
"synopsis": {
"type": "repeat",
"child": { "type": "reference", "symbol": "text" }
}
}

View File

@@ -0,0 +1,7 @@
{
"tsfVersion": "1.0",
"name": "exit",
"summary": "Exit the command processor",
"symbols": {},
"synopsis": { "type": "sequence", "children": [] }
}

View File

@@ -0,0 +1,9 @@
{
"tsfVersion": "1.0",
"name": "mkdir",
"summary": "Create a directory",
"symbols": {
"dir": { "kind": "positional", "type": "path", "name": "DIR", "summary": "Directory to create" }
},
"synopsis": { "type": "reference", "symbol": "dir" }
}

View File

@@ -0,0 +1,16 @@
{
"tsfVersion": "1.0",
"name": "mv",
"summary": "Move or rename a file",
"symbols": {
"source": { "kind": "positional", "type": "file", "name": "SOURCE", "summary": "File to move" },
"dest": { "kind": "positional", "type": "path", "name": "DEST", "summary": "Destination path" }
},
"synopsis": {
"type": "sequence",
"children": [
{ "type": "reference", "symbol": "source" },
{ "type": "reference", "symbol": "dest" }
]
}
}

View File

@@ -0,0 +1,7 @@
{
"tsfVersion": "1.0",
"name": "panic",
"summary": "Deliberately raise an error (diagnostic aid)",
"symbols": {},
"synopsis": { "type": "sequence", "children": [] }
}

View File

@@ -0,0 +1,12 @@
{
"tsfVersion": "1.0",
"name": "rem",
"summary": "A comment; the line is ignored",
"symbols": {
"text": { "kind": "positional", "type": "string", "name": "TEXT", "summary": "Comment text", "completion": { "method": "none" } }
},
"synopsis": {
"type": "repeat",
"child": { "type": "reference", "symbol": "text" }
}
}

View File

@@ -0,0 +1,18 @@
{
"tsfVersion": "1.0",
"name": "set",
"summary": "Set or display an environment variable",
"symbols": {
"assignment": {
"kind": "positional",
"type": "string",
"name": "NAME=VALUE",
"summary": "Variable assignment, or a name to display; lists all variables when omitted",
"completion": { "method": "internal", "provider": "envvars" }
}
},
"synopsis": {
"type": "optional",
"child": { "type": "reference", "symbol": "assignment" }
}
}

View File

@@ -0,0 +1,7 @@
{
"tsfVersion": "1.0",
"name": "ver",
"summary": "Print the operating system version",
"symbols": {},
"synopsis": { "type": "sequence", "children": [] }
}

View File

@@ -0,0 +1,9 @@
{
"tsfVersion": "1.0",
"name": "which",
"summary": "Report how a command name resolves",
"symbols": {
"program": { "kind": "positional", "type": "command", "name": "PROGRAM", "summary": "Command name to resolve" }
},
"synopsis": { "type": "reference", "symbol": "program" }
}