From patchwork Thu Oct 27 10:22:41 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Xose Vazquez Perez X-Patchwork-Id: 9399153 X-Patchwork-Delegate: christophe.varoqui@free.fr Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 0B02060588 for ; Thu, 27 Oct 2016 10:25:33 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id E1D9826907 for ; Thu, 27 Oct 2016 10:25:32 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id D463829EDC; Thu, 27 Oct 2016 10:25:32 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-3.6 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, FREEMAIL_FROM, RCVD_IN_DNSWL_MED, RCVD_IN_SORBS_SPAM, T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from mx5-phx2.redhat.com (mx5-phx2.redhat.com [209.132.183.37]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 39C1026907 for ; Thu, 27 Oct 2016 10:25:28 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by mx5-phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u9RAMn24061841; Thu, 27 Oct 2016 06:22:50 -0400 Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id u9RAMm6L003589 for ; Thu, 27 Oct 2016 06:22:48 -0400 Received: from mx1.redhat.com (ext-mx06.extmail.prod.ext.phx2.redhat.com [10.5.110.30]) by int-mx10.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u9RAMmVd013203 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO) for ; Thu, 27 Oct 2016 06:22:48 -0400 Received: from mail-wm0-f68.google.com (mail-wm0-f68.google.com [74.125.82.68]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 58A473F201 for ; Thu, 27 Oct 2016 10:22:46 +0000 (UTC) Received: by mail-wm0-f68.google.com with SMTP id y138so1937048wme.1 for ; Thu, 27 Oct 2016 03:22:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id; bh=8vb02EXY9+o3hsZ/qkrmDx0BVN35s7jyRlIpF1Wu0Ro=; b=ck3CXF99T8UJOjd7b5KNvKHZLGumiY2oayycLxYlRaPnxhBjHqEGuf/B92bii7ojDF Pp1hfOjKxvtQcDNx/MD9FemUh+BhY9YRP8u/UrugL1HMlGTGPnp7UlyBM/RUQM3DXUTt 9rtPtiIaZRioVLwDcRqeS3xnGyacrwqVMmLO+lPl4YUHvOkcfxVzAPyOAJ2l2OBJByqy hynnkr8tbHfPuZmDLshF+oIZ6qP5wEv8dM42WuLsqewNt7xAlIWR1Kn5dCAqQ/TTCZ06 xDQn1Yo0c3FPMmbfxHdtfWtuBOXG78+FUcb33/M4jw1ptZdAQfG9uxvCLN+1MtJYf7KA Nh/g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=8vb02EXY9+o3hsZ/qkrmDx0BVN35s7jyRlIpF1Wu0Ro=; b=ekVm7qPOfUY9lYHxaZnAokoXtyJH62NfjqB5YwQY8y+XiB7R7Dv9ywGfQFDqiWUwLu d7GjY5tu20pUlN92ADfd+yz5/MWXAMnEa3IoDVGCoWE5FBaxVQ3IuUaxd2FeB9AvsEOg JNiKfEOGihg6Kbgxo43O6vFFW1Qdm1rHA3IqV1i63RJV0WUkMedDJHzVbbgO6mwjWbSd mhdwNghw4EeCKPfR4NfEktZAzj8Qgdk7ykUGaSWTbCUSp54mhVna/j961THvjtIrvbUs 3stjp6zh1Mf1uB2cs+MqHuEXbODqLwYVv3ns+n33Cj42P714j39OXT6PXswrj83FEGZr ZF0w== X-Gm-Message-State: ABUngveY9UmvAyRA1TN0w1g5HftMGVtzyQsp7GN9VKw8ulmAToDKnF/fGeMJMNTbtPoUZA== X-Received: by 10.28.23.199 with SMTP id 190mr6698088wmx.107.1477563764756; Thu, 27 Oct 2016 03:22:44 -0700 (PDT) Received: from localhost ([46.222.208.145]) by smtp.gmail.com with ESMTPSA id jt8sm7639001wjc.33.2016.10.27.03.22.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 27 Oct 2016 03:22:44 -0700 (PDT) From: Xose Vazquez Perez To: Date: Thu, 27 Oct 2016 12:22:41 +0200 Message-Id: <20161027102241.2077-1-xose.vazquez@gmail.com> X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.30]); Thu, 27 Oct 2016 10:22:46 +0000 (UTC) X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.30]); Thu, 27 Oct 2016 10:22:46 +0000 (UTC) for IP:'74.125.82.68' DOMAIN:'mail-wm0-f68.google.com' HELO:'mail-wm0-f68.google.com' FROM:'xose.vazquez@gmail.com' RCPT:'' X-RedHat-Spam-Score: 1.17 * (BAYES_50, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, FREEMAIL_FROM, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, RCVD_IN_SORBS_SPAM, SPF_PASS) 74.125.82.68 mail-wm0-f68.google.com 74.125.82.68 mail-wm0-f68.google.com X-Scanned-By: MIMEDefang 2.68 on 10.5.11.23 X-Scanned-By: MIMEDefang 2.78 on 10.5.110.30 X-loop: dm-devel@redhat.com Cc: device-mapper development , Xose Vazquez Perez Subject: [dm-devel] [PATCH] multipath-tools: clean up and organize multipath/multipath.8 X-BeenThere: dm-devel@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: device-mapper development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: dm-devel-bounces@redhat.com Errors-To: dm-devel-bounces@redhat.com X-Virus-Scanned: ClamAV using ClamSMTP Cc: Christophe Varoqui Cc: device-mapper development Signed-off-by: Xose Vazquez Perez --- multipath/multipath.8 | 159 ++++++++++++++++++++++++++++++++++---------------- 1 file changed, 109 insertions(+), 50 deletions(-) diff --git a/multipath/multipath.8 b/multipath/multipath.8 index 966139e..f0b1ff0 100644 --- a/multipath/multipath.8 +++ b/multipath/multipath.8 @@ -1,7 +1,24 @@ -.TH MULTIPATH 8 "July 2006" "" "Linux Administrator's Manual" +.\" ---------------------------------------------------------------------------- +.\" Update the date below if you make any significant change. +.\" Make sure there are no errors with: +.\" groff -z -wall -b -e -t multipath/multipath.8 +.\" +.\" ---------------------------------------------------------------------------- +. +.TH MULTIPATH 8 2016-10-26 "Linux" +. +. +.\" ---------------------------------------------------------------------------- .SH NAME -multipath \- Device mapper target autoconfig +.\" ---------------------------------------------------------------------------- +. +multipath \- Device mapper target autoconfig. +. +. +.\" ---------------------------------------------------------------------------- .SH SYNOPSIS +.\" ---------------------------------------------------------------------------- +. .B multipath .RB [\| \-v\ \c .IR verbosity \|] @@ -10,124 +27,166 @@ multipath \- Device mapper target autoconfig .RB [\| \-d \|] .RB [\| \-h | \-l | \-ll | \-f | \-t | \-F | \-B | \-c | \-q | \|-r | \|-i | \-a | \|-u | \-w | \-W \|] .RB [\| \-p\ \c -.BR failover | multibus | group_by_serial | group_by_prio | group_by_node_name \|] +.IR failover | multibus | group_by_serial | group_by_prio | group_by_node_name \|] .RB [\| device \|] +. +. +.\" ---------------------------------------------------------------------------- .SH DESCRIPTION +.\" ---------------------------------------------------------------------------- +. .B multipath is used to detect and coalesce multiple paths to devices, for fail-over or performance reasons. +. +. +.\" ---------------------------------------------------------------------------- .SH OPTIONS +.\" ---------------------------------------------------------------------------- +. .TP -.B \-v " level" -verbosity, print all paths and multipaths +.BI \-v " level" +Verbosity, print all paths and multipaths: .RS 1.2i .TP 1.2i -.B 0 -no output +.I 0 +No output. .TP -.B 1 -print the created or updated multipath names only, for use to feed other tools like kpartx +.I 1 +Print the created or updated multipath names only, for use to feed other tools like kpartx. .TP -.B 2 + -print all info : detected paths, coalesced paths (ie multipaths) and device maps +.I 2 + +Print all info: detected paths, coalesced paths (ie multipaths) and device maps. .RE +. .TP .B \-h -print usage text +Print usage text. +. .TP .B \-d -dry run, do not create or update devmaps +Dry run, do not create or update devmaps. +. .TP .B \-l -show the current multipath topology from information fetched in sysfs and the device mapper +Show the current multipath topology from information fetched in sysfs and the device mapper. +. .TP .B \-ll -show the current multipath topology from all available information (sysfs, the device mapper, path checkers ...) +Show the current multipath topology from all available information (sysfs, the device mapper, path checkers ...). +. .TP .B \-f -flush a multipath device map specified as parameter, if unused +Flush a multipath device map specified as parameter, if unused. +. .TP .B \-F -flush all unused multipath device maps +Flush all unused multipath device maps. +. .TP .B \-t -print internal hardware table to stdout +Print internal hardware table to stdout. +. .TP .B \-r -force devmap reload +Force devmap reload. +. .TP .B \-i -ignore wwids file when processing devices +Ignore WWIDs file when processing devices. +. .TP .B \-B -treat the bindings file as read only +Treat the bindings file as read only. +. .TP -.B \-b " bindings_file" -set user_friendly_names bindings file location. The default is -/etc/multipath/bindings +.BI \-b " bindings_file" +Set user_friendly_names bindings file location. The default is +\fI/etc/multipath/bindings\fR. +. .TP .B \-c -check if a block device should be a path in a multipath device +Check if a block device should be a path in a multipath device. +. .TP .B \-q -allow device tables with queue_if_no_path when multipathd is not running +Allow device tables with \fIqueue_if_no_path\fR when multipathd is not running. +. .TP .B \-a -add the wwid for the specified device to the wwids file +Add the WWID for the specified device to the WWIDs file. +. .TP .B \-u -check if the device specified in the program environment should be +Check if the device specified in the program environment should be a path in a multipath device. +. .TP .B \-w -remove the wwid for the specified device from the wwids file +Remove the WWID for the specified device from the WWIDs file. +. .TP .B \-W -reset the wwids file to only include the current multipath devices +Reset the WWIDs file to only include the current multipath devices. +. .TP .BI \-p " policy" -force new maps to use the specified policy: +Force new maps to use the specified policy: .RS 1.2i .TP 1.2i -.B failover -1 path per priority group +.I failover +One path per priority group. .TP -.B multibus -all paths in 1 priority group +.I multibus +All paths in one priority group. .TP -.B group_by_serial -1 priority group per serial +.I group_by_serial +One priority group per serial number. .TP -.B group_by_prio -1 priority group per priority value. Priorities are determined by callout programs specified as a global, per-controller or per-multipath option in the configuration file +.I group_by_prio +One priority group per priority value. Priorities are determined by +callout programs specified as a global, per-controller or +per-multipath option in the configuration file. .TP -.B group_by_node_name -1 priority group per target node name. Target node names are fetched -in /sys/class/fc_transport/target*/node_name. +.I group_by_node_name +One priority group per target node name. Target node names are fetched +in \fI/sys/class/fc_transport/target*/node_name\fR. .TP .RE Existing maps are not modified. +. .TP .BI device -update only the devmap specified by +Update only the devmap specified by .IR device , which is either: .RS 1.2i .IP \[bu] -a devmap name +A devmap name. .IP \[bu] -a path associated with the desired devmap; the path may be in one of the following formats: +A path associated with the desired devmap; the path may be in one of the following formats: .RS 1.2i .IP \[bu] -.B /dev/sdb +.B /dev/sdX .IP \[bu] .B major:minor +. +. +.\" ---------------------------------------------------------------------------- .SH "SEE ALSO" +.\" ---------------------------------------------------------------------------- +. .BR multipathd (8), .BR multipath.conf (5), .BR kpartx (8), .BR udev (8), -.BR dmsetup (8) -.BR hotplug (8) +.BR dmsetup (8), +.BR hotplug (8). +. +. +.\" ---------------------------------------------------------------------------- .SH AUTHORS -.B multipath -was developed by Christophe Varoqui, and others. +.\" ---------------------------------------------------------------------------- +. +\fImultipath-tools\fR was developed by Christophe Varoqui +and others. +.\" EOF