From: Utkarsh Singh <utkarsh190601@gmail.com>
Date: Fri, 19 Mar 2021 23:57:18 +0000 (+0100)
Subject: printf.3: Add overall structure of format string
X-Git-Tag: man-pages-5.12~299
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2fd8db84bf1eb9c0fe5ddc1683dfd252dae611da;p=thirdparty%2Fman-pages.git

printf.3: Add overall structure of format string

Can we add a small syntax structure for format string in printf(3)
manual.  I personally find if easier to remember and scan.  This has
been taken from OpenBSD printf(3) manual.

Signed-off-by: Utkarsh Singh <utkarsh190601@gmail.com>
[ alx: ffix ]
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
---

diff --git a/man3/printf.3 b/man3/printf.3
index fc39053c1a..e5da32970d 100644
--- a/man3/printf.3
+++ b/man3/printf.3
@@ -193,6 +193,14 @@ an optional
 and an optional
 .IR "length modifier" .
 .PP
+Overall syntax of format string is:
+.PP
+.in +4n
+.nf
+%[$][flags][width][.precision][length modifier]conversion
+.fi
+.in
+.PP
 The arguments must correspond properly (after type promotion) with the
 conversion specifier.
 By default, the arguments are used in the order