From owner-freebsd-arch@FreeBSD.ORG Tue May 4 09:17:53 2010 Return-Path: Delivered-To: freebsd-arch@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 64770106564A for ; Tue, 4 May 2010 09:17:53 +0000 (UTC) (envelope-from peterjeremy@acm.org) Received: from mail17.syd.optusnet.com.au (mail17.syd.optusnet.com.au [211.29.132.198]) by mx1.freebsd.org (Postfix) with ESMTP id ECB558FC1E for ; Tue, 4 May 2010 09:17:52 +0000 (UTC) Received: from server.vk2pj.dyndns.org (c122-106-253-149.belrs3.nsw.optusnet.com.au [122.106.253.149]) by mail17.syd.optusnet.com.au (8.13.1/8.13.1) with ESMTP id o449Ho1E012477 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Tue, 4 May 2010 19:17:51 +1000 X-Bogosity: Ham, spamicity=0.000000 Received: from server.vk2pj.dyndns.org (localhost.vk2pj.dyndns.org [127.0.0.1]) by server.vk2pj.dyndns.org (8.14.4/8.14.4) with ESMTP id o449HnS8058632 for ; Tue, 4 May 2010 19:17:49 +1000 (EST) (envelope-from peter@server.vk2pj.dyndns.org) Received: (from peter@localhost) by server.vk2pj.dyndns.org (8.14.4/8.14.4/Submit) id o449Hnc0058631 for freebsd-arch@freebsd.org; Tue, 4 May 2010 19:17:49 +1000 (EST) (envelope-from peter) Date: Tue, 4 May 2010 19:17:49 +1000 From: Peter Jeremy To: freebsd-arch@freebsd.org Message-ID: <20100504091749.GA58464@server.vk2pj.dyndns.org> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="YZ5djTAD1cGYuMQK" Content-Disposition: inline X-PGP-Key: http://members.optusnet.com.au/peterjeremy/pubkey.asc User-Agent: Mutt/1.5.20 (2009-06-14) Subject: Style question: writing multi-line usage messages X-BeenThere: freebsd-arch@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Discussion related to FreeBSD architecture List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 04 May 2010 09:17:53 -0000 --YZ5djTAD1cGYuMQK Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable I would appreciate some input on the preferred style for writing multi-line usage messages. Should: 1) printf() print a series of 1-line strings 2) should string gluing be used to turn multiple strings into one for print= ing 3) should continuation lines be used to create a single string I can't see anything in style(9) to cover this. Variants of the tunefs(8) usage() function follow as examples: void usage(void) { fprintf(stderr, "%s\n%s\n%s\n%s\n%s\n%s\n", "usage: tunefs [-A] [-a enable | disable] [-e maxbpg] [-f avgfilesize]", " [-J enable | disable] [-j enable | disable]",=20 " [-L volname] [-l enable | disable] [-m minfree]", " [-N enable | disable] [-n enable | disable]", " [-o space | time] [-p] [-S size] [-s avgfpdir]", " special | filesystem"); exit(2); } void usage(void) { fprintf(stderr, "usage: tunefs [-A] [-a enable | disable] [-e maxbpg] [-f avgfilesize]\n" " [-J enable | disable] [-j enable | disable]\n" " [-L volname] [-l enable | disable] [-m minfree]\n" " [-N enable | disable] [-n enable | disable]\n" " [-o space | time] [-p] [-S size] [-s avgfpdir]\n" " special | filesystem\n"); exit(2); } void usage(void) { fprintf(stderr, "usage: tunefs [-A] [-a enable | disable] [-e maxbpg] [-f avgfilesize]\n\ [-J enable | disable] [-j enable | disable]\n\ [-L volname] [-l enable | disable] [-m minfree]\n\ [-N enable | disable] [-n enable | disable]\n\ [-o space | time] [-p] [-S size] [-s avgfpdir]\n\ special | filesystem\n"); exit(2); } --=20 Peter Jeremy --YZ5djTAD1cGYuMQK Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.14 (FreeBSD) iEYEARECAAYFAkvf5j0ACgkQ/opHv/APuIeH5wCfd7hzjrnV+K7E4W52xILuvmmx 9MQAoLLSIT/LSRpJ/tSR3lVuBj1FqfdG =VVAd -----END PGP SIGNATURE----- --YZ5djTAD1cGYuMQK--