1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-08-08 22:36:48 +02:00

doc update

This commit is contained in:
Kelly Brazil
2021-08-30 21:53:40 -07:00
parent 0a625ad7dd
commit fb54899dcc
4 changed files with 38 additions and 23 deletions

View File

@@ -5,11 +5,12 @@ jc - JSON CLI output utility `sfdisk` command output parser
Supports the following `sfdisk` options: Supports the following `sfdisk` options:
- `-l` - `-l`
- `-d` - `-F`
- `-uM` - `-d` (deprecated - only for older versions of util-linux)
- `-uC` - `-uM` (deprecated - only for older versions of util-linux)
- `-uS` - `-uC` (deprecated - only for older versions of util-linux)
- `-uB` - `-uS` (deprecated - only for older versions of util-linux)
- `-uB` (deprecated - only for older versions of util-linux)
Usage (cli): Usage (cli):
@@ -28,24 +29,38 @@ Schema:
[ [
{ {
"disk": string, "disk": string,
"cylinders": integer, "disk_size": string,
"heads": integer, "free_disk_size": string,
"sectors_per_track": integer, "bytes": integer,
"units": string, "free_bytes": integer,
"sectors": integer,
"free_sectors": integer,
"cylinders": integer,
"heads": integer,
"sectors_per_track": integer,
"units": string,
"logical_sector_size": integer,
"physical_sector_size": integer,
"min_io_size": integer,
"optimal_io_size": integer,
"disk_label_type": string,
"disk_identifier": string,
"disk_model": string,
"partitions": [ "partitions": [
{ {
"device": string, "device": string,
"boot": boolean, "boot": boolean,
"start": integer, "start": integer,
"end": integer, "end": integer,
"size": integer, "size": integer,
"cyls": integer, "cyls": integer,
"mib": integer, "mib": integer,
"blocks": integer, "blocks": integer,
"sectors": integer, "sectors": integer,
"id": string, "id": string,
"system": string "system": string,
"type": string
} }
] ]
} }
@@ -210,4 +225,4 @@ Returns:
## Parser Information ## Parser Information
Compatibility: linux Compatibility: linux
Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

Binary file not shown.

View File

@@ -1,4 +1,4 @@
.TH jc 1 2021-08-16 1.16.1 "JSON CLI output utility" .TH jc 1 2021-08-30 1.16.2 "JSON CLI output utility"
.SH NAME .SH NAME
jc \- JSONifies the output of many CLI tools and file-types jc \- JSONifies the output of many CLI tools and file-types
.SH SYNOPSIS .SH SYNOPSIS

Binary file not shown.