1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-21 00:19:42 +02:00

doc update

This commit is contained in:
Kelly Brazil
2024-03-18 10:26:00 -07:00
parent 475eedb142
commit b84123a09b
4 changed files with 60 additions and 60 deletions

View File

@ -13,6 +13,7 @@ jc changelog
- Enhance `/proc/pid/stat` parser to support "Idle" state - Enhance `/proc/pid/stat` parser to support "Idle" state
- Enhance `rpm_qi` and `pkg_index_deb` parsers to split list fields into arrays - Enhance `rpm_qi` and `pkg_index_deb` parsers to split list fields into arrays
- Fix `iwconfig` parser to handle more special characters in the SSID name - Fix `iwconfig` parser to handle more special characters in the SSID name
- Add aarch64 binaries to Releases for macOS and Linux
- Documentation and doc build updates - Documentation and doc build updates
20240212 v1.25.1 20240212 v1.25.1

View File

@ -33,6 +33,16 @@ Schema:
"maximum_height": integer, "maximum_height": integer,
"devices": [ "devices": [
{ {
"props": {
# either an EdidModel object or key value pairs
<key_name> : {
"name": string,
"product_id": string,
"serial_number": string,
}
},
"resolution_modes": [ "resolution_modes": [
{ {
"resolution_width": integer, "resolution_width": integer,
@ -92,26 +102,9 @@ Examples:
"frequency": 60.03, "frequency": 60.03,
"is_current": true, "is_current": true,
"is_preferred": true "is_preferred": true
},
{
"frequency": 59.93,
"is_current": false,
"is_preferred": false
} }
] ]
}, },
{
"resolution_width": 1680,
"resolution_height": 1050,
"is_high_resolution": false,
"frequencies": [
{
"frequency": 59.88,
"is_current": false,
"is_preferred": false
}
]
}
], ],
"is_connected": true, "is_connected": true,
"is_primary": true, "is_primary": true,
@ -134,40 +127,41 @@ Examples:
{ {
"screens": [ "screens": [
{ {
"screen_number": 0,
"minimum_width": 8,
"minimum_height": 8,
"current_width": 1920,
"current_height": 1080,
"maximum_width": 32767,
"maximum_height": 32767,
"devices": [ "devices": [
{ {
"props": {
"EDID": [
"00ffff5700000000",
"001c01a5544d9a27",
"0e50540101010101",
"010101383e401010",
"3500350f00000000",
"0000000000fe0041",
"554f0a20000000fe",
"00423137200a0070"
],
"scaling mode": [
"Full aspect ",
"supported: Full, Center, Full aspect"
],
"Colorspace": [
"Default ",
"supported: Default, RGB_Wide_Gamut_Fixed_Point, RGB_Wide_Gamut_Floating_Point, opRGB, DCI-P3_RGB_D65, BT2020_RGB, BT601_YCC, BT709_YCC, XVYCC_601, XVYCC_709, SYCC_601, opYCC_601, BT2020_CYCC, BT2020_YCC"
],
"EdidModel": {
"name": "Generic",
"product_id": "22333",
"serial_number": "0"
}
},
"resolution_modes": [ "resolution_modes": [
{ {
"resolution_width": 1920, "resolution_width": 320,
"resolution_height": 1080, "resolution_height": 180,
"is_high_resolution": false, "is_high_resolution": false,
"frequencies": [ "frequencies": [
{ {
"frequency": 60.03, "frequency": 59.84,
"is_current": true,
"is_preferred": true
},
{
"frequency": 59.93,
"is_current": false,
"is_preferred": false
}
]
},
{
"resolution_width": 1680,
"resolution_height": 1050,
"is_high_resolution": false,
"frequencies": [
{
"frequency": 59.88,
"is_current": false, "is_current": false,
"is_preferred": false "is_preferred": false
} }
@ -176,20 +170,24 @@ Examples:
], ],
"is_connected": true, "is_connected": true,
"is_primary": true, "is_primary": true,
"device_name": "eDP1", "device_name": "eDP-1",
"model_name": "ASUS VW193S", "rotation": "normal",
"product_id": "54297", "reflection": "normal",
"serial_number": "78L8021107",
"resolution_width": 1920, "resolution_width": 1920,
"resolution_height": 1080, "resolution_height": 1080,
"offset_width": 0, "offset_width": 0,
"offset_height": 0, "offset_height": 0,
"dimension_width": 310, "dimension_width": 309,
"dimension_height": 170, "dimension_height": 174
"rotation": "normal",
"reflection": "normal"
} }
] ],
"screen_number": 0,
"minimum_width": 320,
"minimum_height": 200,
"current_width": 1920,
"current_height": 1080,
"maximum_width": 16384,
"maximum_height": 16384
} }
] ]
} }
@ -221,4 +219,4 @@ Compatibility: linux, darwin, cygwin, aix, freebsd
Source: [`jc/parsers/xrandr.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/xrandr.py) Source: [`jc/parsers/xrandr.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/xrandr.py)
Version 2.0 by Kevin Lyter (code (at) lyterk.com) Version 2.1 by Kevin Lyter (code (at) lyterk.com)

View File

@ -15,6 +15,7 @@ Usage (module):
result = jc.parse('xrandr', xrandr_command_output) result = jc.parse('xrandr', xrandr_command_output)
Schema: Schema:
{ {
"screens": [ "screens": [
{ {
@ -28,14 +29,14 @@ Schema:
"devices": [ "devices": [
{ {
"props": { "props": {
[name: string]: {
// Represents EdidModel # either an EdidModel object or key value pairs
<key_name> : {
"name": string, "name": string,
"product_id": string, "product_id": string,
"serial_number": string, "serial_number": string,
} }
|
list[string]
}, },
"resolution_modes": [ "resolution_modes": [
{ {
@ -206,7 +207,7 @@ except AttributeError:
class info: class info:
"""Provides parser metadata (version, author, etc.)""" """Provides parser metadata (version, author, etc.)"""
version = "2.0" version = "2.1"
description = "`xrandr` command parser" description = "`xrandr` command parser"
author = "Kevin Lyter" author = "Kevin Lyter"
author_email = "code (at) lyterk.com" author_email = "code (at) lyterk.com"

View File

@ -1,4 +1,4 @@
.TH jc 1 2024-03-15 1.25.2 "JSON Convert" .TH jc 1 2024-03-18 1.25.2 "JSON Convert"
.SH NAME .SH NAME
\fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types, \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types,
and strings and strings