From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 464091FF16F for ; Tue, 13 May 2025 15:55:59 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id E1E3333601; Tue, 13 May 2025 15:56:19 +0200 (CEST) From: Alexander Abraham To: pve-devel@lists.proxmox.com Date: Tue, 13 May 2025 15:55:38 +0200 Message-Id: <20250513135538.83155-1-a.abraham@proxmox.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: References: MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.091 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pve-devel] [PATCH pve-docs v2] fix #4554: pve-docs: Fixed some style nits. X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" These commit fixes some style nits, rephrases a few things that were unclear and elboartes on the different output formats that the "pvesh" command offers. Signed-off-by: Alexander Abraham --- output-format.adoc | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/output-format.adoc b/output-format.adoc index b3eb3c4..43f4914 100644 --- a/output-format.adoc +++ b/output-format.adoc @@ -8,16 +8,26 @@ FORMAT_OPTIONS endif::manvolnum[] It is possible to specify the output format using the -`--output-format` parameter. The default format 'text' uses ASCII-art -to draw nice borders around tables. It additionally transforms some -values into human-readable text, for example: +`--output-format` parameter. The default format, 'text', uses ASCII art +to draw nice borders around tables. Different output formats, such as +"text" or "json", provide different functionality for different use +cases. The `text` output format is supposed to present +easily-understandable information in a human-readable format. +The goal of the `json` output is that the output is parsable and +processable by different tools. -- Unix epoch is displayed as ISO 8601 date string. -- Durations are displayed as week/day/hour/minute/second count, i.e `1d 5h`. +The `text` output format additionally transforms some values into +human-readable text, for example: + +- Unix epoch is displayed as an ISO 8601 date string. +- Durations are displayed as week/day/hour/minute/second count, e.g. `1d 5h`. - Byte sizes value include units (`B`, `KiB`, `MiB`, `GiB`, `TiB`, `PiB`). - Fractions are display as percentage, i.e. 1.0 is displayed as 100%. You can also completely suppress output using option `--quiet`. +The information displayed is only a subset of all available +information. + include::output-format-opts.adoc[] -- 2.39.5 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel