From nobody Tue Nov 26 11:29:14 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) client-ip=205.139.110.61; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575643879; cv=none; d=zohomail.com; s=zohoarc; b=Cnx/ZzRo1j6z4NNCR+3j6bXHS6444FYImsT7JHidZc/h3t4NcBLy8UkZqhUdTNfwjSn/pyUPrum7zuj1edF1VJPPqvHDucRz9w1Bvvo1innGHPqlVJ5dLElrligJ512Un/0V7+hqU4IVNausFVvLAOe2tCmUv1xwgVTFgH34PWo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575643879; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=zhxzXiK7tGoIc2qS5VQgNo05RcuMtHwMIDGog2JgNxs=; b=SsdGDfVPiWDre+uhmmFbhabYsmjTXnYtaULvqSpyeoeOVkVJvIx+cDrq8Q3tyGIXql2xVkz3hr5jBry+mwjkvq6eJXlGmeEFrZyyJA9EBrs7NvLsqXFFCTTMHuBF69rDQsWe/RztABSlV5J26qIfDRZUuYCr83ufq0tF5AAb2bk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [205.139.110.61]) by mx.zohomail.com with SMTPS id 1575643879868371.6696305696697; Fri, 6 Dec 2019 06:51:19 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-90-E1WTCtY4PbO20ISZE4Vrgg-1; Fri, 06 Dec 2019 09:51:16 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 87210DB63; Fri, 6 Dec 2019 14:51:11 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 61E1F6013B; Fri, 6 Dec 2019 14:51:11 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 2594D6B4B2; Fri, 6 Dec 2019 14:51:11 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id xB6Ep9wG017002 for ; Fri, 6 Dec 2019 09:51:09 -0500 Received: by smtp.corp.redhat.com (Postfix) id 5B7D95DA32; Fri, 6 Dec 2019 14:51:09 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id 01ED75D9E2; Fri, 6 Dec 2019 14:51:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643878; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=zhxzXiK7tGoIc2qS5VQgNo05RcuMtHwMIDGog2JgNxs=; b=TyiZRgV9MPv89qbfpP5ENA4AoyWIG+SyxWR8PEs+xxlh53Dxb+RPoSg0QA1Abd5aW5WiKo ohqQIXuwR3EQzo1NnA4FdBvDagdC3pxbbXalcWPpM5jPNOyGje2aagahAaZ0bgp+gAPdvX in2HfcXxU3PROiG/TTONRXgukG7/DUM= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:30 +0000 Message-Id: <20191206145042.3777845-6-berrange@redhat.com> In-Reply-To: <20191206145042.3777845-1-berrange@redhat.com> References: <20191206145042.3777845-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 05/17] docs: describe the basic RST structure for a man page X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-MC-Unique: E1WTCtY4PbO20ISZE4Vrgg-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Signed-off-by: Daniel P. Berrang=C3=A9 --- docs/styleguide.rst | 86 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) diff --git a/docs/styleguide.rst b/docs/styleguide.rst index 71f29320cb..2998e90963 100644 --- a/docs/styleguide.rst +++ b/docs/styleguide.rst @@ -64,3 +64,89 @@ which allows for 6 levels of headings =20 Heading 6 ^^^^^^^^^ + +Manual pages +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +RST documents created as manual pages must have the following structure + +:: + + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + ::PROGRAM:: + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + + --------------------------- + ...line line description... + --------------------------- + + :Manual section: 8 + :Manual group: Virtualization Support + + .. contents:: + + SYNOPSIS + =3D=3D=3D=3D=3D=3D=3D=3D + + ``::PROGRAM::`` [*OPTION*]... + + DESCRIPTION + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + + ...describe the tool / program ... + + OPTIONS + =3D=3D=3D=3D=3D=3D=3D + + ``-h``, ``--help`` + + Display command line help usage then exit. + + ...and other args.... + + FILES + =3D=3D=3D=3D=3D + + ...any files used that the user needs to know about. eg config + files in particular... + + AUTHORS + =3D=3D=3D=3D=3D=3D=3D + + Please refer to the AUTHORS file distributed with libvirt. + + BUGS + =3D=3D=3D=3D + + Please report all bugs you discover. This should be done via either: + + #. the mailing list + + `https://libvirt.org/contact.html `_ + + #. the bug tracker + + `https://libvirt.org/bugs.html `_ + + Alternatively, you may report bugs to your software distributor / vendor. + + + COPYRIGHT + =3D=3D=3D=3D=3D=3D=3D=3D=3D + + Copyright (C) ::DATE:: ::ORIGINAL AUTHOR::, and the authors listed in the + libvirt AUTHORS file. + + LICENSE + =3D=3D=3D=3D=3D=3D=3D + + ``::PROGRAM::`` is distributed under the terms of the GNU LGPL v2.1+. + This is free software; see the source for copying conditions. There + is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE + + SEE ALSO + =3D=3D=3D=3D=3D=3D=3D=3D + + ...other man page links.... + `https://www.libvirt.org/ `_ --=20 2.23.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list