[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Quilt-dev] [patch v2 08/26] Man page: make synopsis comprehensive
From: |
Jean Delvare |
Subject: |
[Quilt-dev] [patch v2 08/26] Man page: make synopsis comprehensive |
Date: |
Tue, 26 Jul 2022 14:43:16 +0200 |
User-agent: |
quilt/0.67 |
Document --quiltrc, --trace, and --version options explicitly.
Separate the informational operation modes for reporting help and
version information.
Mark up synopsis canonically (literals in bold, variable content in
italics, and roman for "synopsis language" (option brackets, etc.)).
Use groff_man(7)'s SY and YS macros for more attractive presentation.
[JD: Restore [options] and strip duplicate line]
---
doc/quilt.1.in | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)
--- quilt.orig/doc/quilt.1.in 2022-07-05 15:25:26.954109879 +0200
+++ quilt/doc/quilt.1.in 2022-07-05 21:48:28.713435523 +0200
@@ -6,8 +6,18 @@
quilt \\- tool to manage series of patches
.
.SH SYNOPSIS
-.B quilt
-[\\-h] command [options]
+.SY quilt
+.RB [ \\-\\-quiltrc
+.IR file ]
+.OP \\-\\-trace
+.I command
+.RI [ options ]
+.YS
+.SY quilt
+.RI [ command ]
+\\-h
+.SY "quilt \\-\\-version"
+.YS
.
.SH DESCRIPTION
Quilt is a tool to manage large sets of patches by keeping track of the
- [Quilt-dev] [patch v2 00/26] doc/quilt.1.in refactor revisited, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 01/26] Man page: the man macro RE is given an argument when it does not need one, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 02/26] Man page: eliminate or replace blank lines, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 03/26] Man page: break input lines at all sentence endings, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 04/26] Man page: reorganize sections, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 05/26] Man page: use font macros instead of font escapes, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 06/26] Man page: use groff_man(7)s EX and EE macros for examples, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 07/26] Man page: escape ASCII hyphen-minus characters used as such, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 08/26] Man page: make synopsis comprehensive,
Jean Delvare <=
- [Quilt-dev] [patch v2 09/26] Man page: use character escapes for directional quotes and spacing tilde, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 10/26] Man page: use "e.g." correctly, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 11/26] Man page: italicize work titles, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 12/26] Man page: update internal and external cross-references, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 13/26] Man page: set filespecs and environment variable names in italics, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 14/26] Man page: document -h flag in the Options section, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 15/26] Man page: capitalize "PDF" when not part of a filename, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 16/26] Man page: render Andreas Gruenbachers name with a u-umlaut, Jean Delvare, 2022/07/26