From patchwork Tue Apr 15 07:04:50 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Qu Wenruo X-Patchwork-Id: 3989471 Return-Path: X-Original-To: patchwork-linux-btrfs@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 84F909F2BA for ; Tue, 15 Apr 2014 07:04:02 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id A4369201FB for ; Tue, 15 Apr 2014 07:04:01 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 9DF2220166 for ; Tue, 15 Apr 2014 07:04:00 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752462AbaDOHDz (ORCPT ); Tue, 15 Apr 2014 03:03:55 -0400 Received: from cn.fujitsu.com ([59.151.112.132]:39014 "EHLO heian.cn.fujitsu.com" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1751104AbaDOHDx (ORCPT ); Tue, 15 Apr 2014 03:03:53 -0400 X-IronPort-AV: E=Sophos;i="4.97,862,1389715200"; d="scan'208,217";a="29275516" Received: from unknown (HELO edo.cn.fujitsu.com) ([10.167.33.5]) by heian.cn.fujitsu.com with ESMTP; 15 Apr 2014 15:01:24 +0800 Received: from G08CNEXCHPEKD03.g08.fujitsu.local (localhost.localdomain [127.0.0.1]) by edo.cn.fujitsu.com (8.14.3/8.13.1) with ESMTP id s3F73oev001772 for ; Tue, 15 Apr 2014 15:03:50 +0800 Received: from adam-work.lan (10.167.226.24) by G08CNEXCHPEKD03.g08.fujitsu.local (10.167.33.89) with Microsoft SMTP Server (TLS) id 14.3.146.2; Tue, 15 Apr 2014 15:03:56 +0800 From: Qu Wenruo To: Subject: [PATCH 2/4] btrfs-progs: Convert man page for btrfs-property. Date: Tue, 15 Apr 2014 15:04:50 +0800 Message-ID: <1397545492-3054-2-git-send-email-quwenruo@cn.fujitsu.com> X-Mailer: git-send-email 1.9.2 In-Reply-To: <1397545492-3054-1-git-send-email-quwenruo@cn.fujitsu.com> References: <1397545492-3054-1-git-send-email-quwenruo@cn.fujitsu.com> MIME-Version: 1.0 X-Originating-IP: [10.167.226.24] Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org X-Spam-Status: No, score=-7.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=ham version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Convert the man page for the newly added btrfs-property subcommand. Signed-off-by: Qu Wenruo --- Documentation/Makefile | 1 + Documentation/btrfs-property.txt | 69 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) create mode 100644 Documentation/btrfs-property.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index dfacb93..241b41d 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -31,6 +31,7 @@ MAN8_TXT += btrfs-qgroup.txt MAN8_TXT += btrfs-replace.txt MAN8_TXT += btrfs-dedup.txt MAN8_TXT += btrfs-restore.txt +MAN8_TXT += btrfs-property.txt MAN_TXT = $(MAN8_TXT) MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT)) diff --git a/Documentation/btrfs-property.txt b/Documentation/btrfs-property.txt new file mode 100644 index 0000000..82466f9 --- /dev/null +++ b/Documentation/btrfs-property.txt @@ -0,0 +1,69 @@ +btrfs-property(8) +================= + +NAME +---- +btrfs-property - get/set/list properties for given btrfs object. + +SYNOPSIS +-------- +'btrfs property' + +DESCRIPTION +----------- +'btrfs property' is used to get/set/list property, like lable or compression +state, for given btrfs object. + +'btrfs property' provides an unified and user-friendly method to tune different +btrfs properties instead of using the traditional method like `chattr`(1) or +`lsattr`(1). + +SUBCOMMAND +---------- +'get' [-t ] []:: +Gets a property from a btrfs object. ++ +If no name is specified, all properties for the given object are +printed. +A filesystem object can be a the filesystem itself, a subvolume, +an inode or a device. ++ +The '-t ' option can be used to explicitly +specify what type of object you meant. This is only needed when a +property could be set for more then one object type. ++ +Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]' and 'd[evice]'. ++ +The can be path of btrfs device, btrfs mount point, or any +directories/files inside btrfs. + +'set' [-t ] :: +Sets a property on a btrfs object. ++ +See description of 'get' subcommand for a description of objects and object +types. + +'list' [-t ] :: +Lists available properties with their descriptions for the given object. ++ +Please see the help of 'btrfs property get' for a description of +objects and object types. + +EXIT STATUS +----------- +'btrfs property' returns a zero exist status if it succeeds. Non zero is +returned in case of failure. + +AVAILABILITY +------------ +'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy +development, +and not suitable for any uses other than benchmarking and review. +Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for +further details. + +SEE ALSO +-------- +`mkfs.btrfs`(8), +`lsattr`(1), +`setattr`(8)