doc update and process pid integers

2025-10-08 23:22:21 +02:00 · 2020-03-01 17:04:06 -08:00
parent f9982a7947
commit dd3a3ac302
4 changed files with 254 additions and 8 deletions
--- a/docs/parsers/who.md
+++ b/docs/parsers/who.md
@@ -0,0 +1,150 @@
+# jc.parsers.who
+jc - JSON CLI output utility who Parser
+
+Usage:
+
+    specify --who as the first argument if the piped input is coming from who
+
+Compatibility:
+
+    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+
+Examples:
+
+    $ who -a | jc --who -p
+    [
+      {
+        "event": "reboot",
+        "time": "Feb 7 23:31",
+        "pid": 1
+      },
+      {
+        "user": "joeuser",
+        "writeable_tty": "?",
+        "tty": "console",
+        "time": "Feb 7 23:32",
+        "idle": "old",
+        "pid": 105
+      },
+      {
+        "user": "joeuser",
+        "writeable_tty": "+",
+        "tty": "ttys000",
+        "time": "Feb 13 16:44",
+        "idle": ".",
+        "pid": 51217,
+        "comment": "term=0 exit=0"
+      },
+      {
+        "user": "joeuser",
+        "writeable_tty": "+",
+        "tty": "ttys003",
+        "time": "Feb 28 08:59",
+        "idle": "01:36",
+        "pid": 41402
+      },
+      {
+        "user": "joeuser",
+        "writeable_tty": "+",
+        "tty": "ttys004",
+        "time": "Mar 1 16:35",
+        "idle": ".",
+        "pid": 15679,
+        "from": "192.168.1.5"
+      }
+    ]
+
+    $ who -a | jc --who -p -r
+    [
+      {
+        "event": "reboot",
+        "time": "Feb 7 23:31",
+        "pid": "1"
+      },
+      {
+        "user": "joeuser",
+        "writeable_tty": "?",
+        "tty": "console",
+        "time": "Feb 7 23:32",
+        "idle": "old",
+        "pid": "105"
+      },
+      {
+        "user": "joeuser",
+        "writeable_tty": "+",
+        "tty": "ttys000",
+        "time": "Feb 13 16:44",
+        "idle": ".",
+        "pid": "51217",
+        "comment": "term=0 exit=0"
+      },
+      {
+        "user": "joeuser",
+        "writeable_tty": "+",
+        "tty": "ttys003",
+        "time": "Feb 28 08:59",
+        "idle": "01:36",
+        "pid": "41402"
+      },
+      {
+        "user": "joeuser",
+        "writeable_tty": "+",
+        "tty": "ttys004",
+        "time": "Mar 1 16:35",
+        "idle": ".",
+        "pid": "15679",
+        "from": "192.168.1.5"
+      }
+    ]
+
+## info
+```python
+info(self, /, *args, **kwargs)
+```
+
+## process
+```python
+process(proc_data)
+```
+
+Final processing to conform to the schema.
+
+Parameters:
+
+    proc_data:   (dictionary) raw structured data to process
+
+Returns:
+
+    List of dictionaries. Structured data with the following schema:
+
+    [
+      {
+        "user":            string,
+        "event":           string,
+        "writeable_tty":   string,
+        "tty":             string,
+        "time":            string,
+        "idle":            string,
+        "pid":             integer,
+        "from":            string,
+        "comment":         string
+      }
+    ]
+
+## parse
+```python
+parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) output preprocessed JSON if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of dictionaries. Raw or processed structured data.
+