summaryrefslogtreecommitdiff
path: root/man/ceph-osd.8
diff options
context:
space:
mode:
Diffstat (limited to 'man/ceph-osd.8')
-rw-r--r--man/ceph-osd.8126
1 files changed, 126 insertions, 0 deletions
diff --git a/man/ceph-osd.8 b/man/ceph-osd.8
new file mode 100644
index 00000000000..79d9839bd40
--- /dev/null
+++ b/man/ceph-osd.8
@@ -0,0 +1,126 @@
+.TH "COSD" "8" "September 09, 2011" "dev" "Ceph"
+.SH NAME
+cosd \- ceph object storage daemon
+.
+.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
+..
+.\" Man page generated from reStructeredText.
+.
+.SH SYNOPSIS
+.nf
+\fBcosd\fP \-i \fIosdnum\fP [ \-\-osd\-data \fIdatapath\fP ] [ \-\-osd\-journal
+\fIjournal\fP ] [ \-\-mkfs ] [ \-\-mkjournal ] [ \-\-mkkey ]
+.fi
+.sp
+.SH DESCRIPTION
+.sp
+\fBcosd\fP is the object storage daemon for the Ceph distributed file
+system. It is responsible for storing objects on a local file system
+and providing access to them over the network.
+.sp
+The datapath argument should be a directory on a btrfs file system
+where the object data resides. The journal is optional, and is only
+useful performance\-wise when it resides on a different disk than
+datapath with low latency (ideally, an NVRAM device).
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-f, \-\-foreground
+Foreground: do not daemonize after startup (run in foreground). Do
+not generate a pid file. Useful when run via \fBcrun\fP(8).
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-d
+Debug mode: like \fB\-f\fP, but also send all log output to stderr.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-osd\-data osddata
+Use object store at \fIosddata\fP.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-osd\-journal journal
+Journal updates to \fIjournal\fP.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-mkfs
+Create an empty object repository. Normally invoked by
+\fBmkcephfs\fP(8). This also initializes the journal
+(if one is defined).
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-mkkey
+Generate a new secret key. This is normally used in combination
+with \fB\-\-mkfs\fP as it is more convenient than generating a key by
+hand with \fBcauthtool\fP(8).
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-mkjournal
+Create a new journal file to match an existing object repository.
+This is useful if the journal device or file is wiped out due to a
+disk or file system failure.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-flush\-journal
+Flush the journal to permanent store. This runs in the foreground
+so you know when it\(aqs completed. This can be useful if you want to
+resize the journal or need to otherwise destroy it: this guarantees
+you won\(aqt lose data.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP for runtime configuration options.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through
+\fBceph.conf\fP).
+.UNINDENT
+.SH AVAILABILITY
+.sp
+\fBcosd\fP is part of the Ceph distributed file system. Please refer to
+the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
+.SH SEE ALSO
+.sp
+\fBceph\fP(8),
+\fBcmds\fP(8),
+\fBcmon\fP(8),
+\fBcauthtool\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.