mirror of
https://github.com/ceph/ceph
synced 2024-12-23 20:03:56 +00:00
058f433930
In the source code of cephfs there is no reference to it anymore, but it's still in the man page. Leave it there for now, but make it more clear that it is deprecated and unsupported.
145 lines
3.8 KiB
Groff
145 lines
3.8 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "CEPHFS" "8" "January 12, 2014" "dev" "Ceph"
|
|
.SH NAME
|
|
cephfs \- ceph file system options utility
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fBcephfs\fP [ \fIpath\fP \fIcommand\fP \fIoptions\fP ]
|
|
.fi
|
|
.sp
|
|
.SH DESCRIPTION
|
|
.sp
|
|
\fBcephfs\fP is a control utility for accessing and manipulating file
|
|
layout and location data in the Ceph distributed storage system.
|
|
.sp
|
|
Choose one of the following three commands:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fBshow_layout\fP View the layout information on a file or directory
|
|
.IP \(bu 2
|
|
\fBset_layout\fP Set the layout information on a file or directory
|
|
.IP \(bu 2
|
|
\fBshow_location\fP View the location information on a file
|
|
.UNINDENT
|
|
.SH OPTIONS
|
|
.sp
|
|
Your applicable options differ depending on whether you are setting or viewing layout/location.
|
|
.SS Viewing options:
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-l \-\-offset
|
|
Specify an offset for which to retrieve location data
|
|
.UNINDENT
|
|
.SS Setting options:
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-u \-\-stripe_unit
|
|
Set the size of each stripe
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-c \-\-stripe_count
|
|
Set the number of objects to stripe across
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-s \-\-object_size
|
|
Set the size of the objects to stripe across
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-p \-\-pool
|
|
Set the pool (by numeric value, not name!) to use
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-o \-\-osd
|
|
Set the preferred OSD to use as the primary (deprecated and ignored)
|
|
.UNINDENT
|
|
.SH LIMITATIONS
|
|
.sp
|
|
When setting layout data, the specified object size must evenly divide
|
|
by the specified stripe unit. Any parameters you don\(aqt set
|
|
explicitly are left at the system defaults.
|
|
.sp
|
|
Obviously setting the layout of a file and a directory means different
|
|
things. Setting the layout of a file specifies exactly how to place
|
|
the individual file. This must be done before writing \fIany\fP data to
|
|
it. Truncating a file does not allow you to change the layout either.
|
|
.sp
|
|
Setting the layout of a directory sets the "default layout", which is
|
|
used to set the file layouts on any files subsequently created in the
|
|
directory (or any subdirectory). Pre\-existing files do not have their
|
|
layouts changed.
|
|
.sp
|
|
You\(aqll notice that the layout information allows you to specify a
|
|
preferred OSD for placement. This feature is unsupported and ignored
|
|
in modern versions of the Ceph servers; do not use it.
|
|
.SH AVAILABILITY
|
|
.sp
|
|
\fBcephfs\fP is part of the Ceph distributed storage system. Please refer
|
|
to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
|
|
information.
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fBceph\fP(8)
|
|
.SH COPYRIGHT
|
|
2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
|
|
.\" Generated by docutils manpage writer.
|
|
.
|