1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-15 01:24:29 +02:00

doc update

This commit is contained in:
Kelly Brazil
2023-11-24 10:38:33 -08:00
parent 1c60f5355e
commit f44260603e
2 changed files with 102 additions and 20 deletions

View File

@ -7,11 +7,11 @@ jc - JSON Convert `debconf-show` command output parser
Usage (cli): Usage (cli):
$ debconf-show | jc --debconf-show $ debconf-show onlyoffice-documentserver | jc --debconf-show
or or
$ jc debconf-show $ jc debconf-show onlyoffice-documentserver
Usage (module): Usage (module):
@ -22,19 +22,60 @@ Schema:
[ [
{ {
"debconf-show": string, "asked": boolean,
"bar": boolean, "packagename": string,
"baz": integer "name": string,
"value": string
} }
] ]
Examples: Examples:
$ debconf-show | jc --debconf-show -p $ debconf-show onlyoffice-documentserver | jc --debconf-show -p
[] [
{
$ debconf-show | jc --debconf-show -p -r "asked": true,
[] "packagename": "onlyoffice",
"name": "jwt_secret",
"value": "aL8ei2iereuzee7cuJ6Cahjah1ixee2ah"
},
{
"asked": false,
"packagename": "onlyoffice",
"name": "db_pwd",
"value": "(password omitted)"
},
{
"asked": true,
"packagename": "onlyoffice",
"name": "rabbitmq_pwd",
"value": "(password omitted)"
},
{
"asked": true,
"packagename": "onlyoffice",
"name": "db_port",
"value": "5432"
},
{
"asked": true,
"packagename": "onlyoffice",
"name": "db_user",
"value": "onlyoffice"
},
{
"asked": true,
"packagename": "onlyoffice",
"name": "rabbitmq_proto",
"value": "amqp"
},
{
"asked": true,
"packagename": "onlyoffice",
"name": "cluster_mode",
"value": "false"
}
]
<a id="jc.parsers.debconf_show.parse"></a> <a id="jc.parsers.debconf_show.parse"></a>

View File

@ -2,11 +2,11 @@
Usage (cli): Usage (cli):
$ debconf-show | jc --debconf-show $ debconf-show onlyoffice-documentserver | jc --debconf-show
or or
$ jc debconf-show $ jc debconf-show onlyoffice-documentserver
Usage (module): Usage (module):
@ -17,19 +17,60 @@ Schema:
[ [
{ {
"debconf-show": string, "asked": boolean,
"bar": boolean, "packagename": string,
"baz": integer "name": string,
"value": string
} }
] ]
Examples: Examples:
$ debconf-show | jc --debconf-show -p $ debconf-show onlyoffice-documentserver | jc --debconf-show -p
[] [
{
$ debconf-show | jc --debconf-show -p -r "asked": true,
[] "packagename": "onlyoffice",
"name": "jwt_secret",
"value": "aL8ei2iereuzee7cuJ6Cahjah1ixee2ah"
},
{
"asked": false,
"packagename": "onlyoffice",
"name": "db_pwd",
"value": "(password omitted)"
},
{
"asked": true,
"packagename": "onlyoffice",
"name": "rabbitmq_pwd",
"value": "(password omitted)"
},
{
"asked": true,
"packagename": "onlyoffice",
"name": "db_port",
"value": "5432"
},
{
"asked": true,
"packagename": "onlyoffice",
"name": "db_user",
"value": "onlyoffice"
},
{
"asked": true,
"packagename": "onlyoffice",
"name": "rabbitmq_proto",
"value": "amqp"
},
{
"asked": true,
"packagename": "onlyoffice",
"name": "cluster_mode",
"value": "false"
}
]
""" """
from typing import List, Dict from typing import List, Dict
from jc.jc_types import JSONDictType from jc.jc_types import JSONDictType