diff options
author | Mike Frysinger <vapier@gentoo.org> | 2004-04-04 19:52:58 +0000 |
---|---|---|
committer | Mike Frysinger <vapier@gentoo.org> | 2004-04-04 19:52:58 +0000 |
commit | 1c6184cebc8ff84ea09e4ddd1587350d8aad31df (patch) | |
tree | abf1a0a99c5003faa23209dc0ca8504902f92f0c /sys-apps/nbd | |
parent | fixing Manifest (diff) | |
download | gentoo-2-1c6184cebc8ff84ea09e4ddd1587350d8aad31df.tar.gz gentoo-2-1c6184cebc8ff84ea09e4ddd1587350d8aad31df.tar.bz2 gentoo-2-1c6184cebc8ff84ea09e4ddd1587350d8aad31df.zip |
install manpages
Diffstat (limited to 'sys-apps/nbd')
-rw-r--r-- | sys-apps/nbd/ChangeLog | 7 | ||||
-rw-r--r-- | sys-apps/nbd/files/digest-nbd-2.0-r1 | 1 | ||||
-rw-r--r-- | sys-apps/nbd/files/nbd-client.8 | 99 | ||||
-rw-r--r-- | sys-apps/nbd/files/nbd-server.1 | 125 | ||||
-rw-r--r-- | sys-apps/nbd/nbd-2.0-r1.ebuild | 30 |
5 files changed, 261 insertions, 1 deletions
diff --git a/sys-apps/nbd/ChangeLog b/sys-apps/nbd/ChangeLog index aefebd48a13e..1f6126222d98 100644 --- a/sys-apps/nbd/ChangeLog +++ b/sys-apps/nbd/ChangeLog @@ -1,6 +1,11 @@ # ChangeLog for sys-apps/nbd # Copyright 2002-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2 -# $Header: /var/cvsroot/gentoo-x86/sys-apps/nbd/ChangeLog,v 1.6 2003/04/20 22:54:52 agenkin Exp $ +# $Header: /var/cvsroot/gentoo-x86/sys-apps/nbd/ChangeLog,v 1.7 2004/04/04 19:52:58 vapier Exp $ + +*nbd-2.0-r1 (04 Apr 2004) + + 04 Apr 2004; Mike Frysinger <vapier@gentoo.org> : + Fix src_install() and install manpages. *nbd-2.0 (20 Apr 2003) diff --git a/sys-apps/nbd/files/digest-nbd-2.0-r1 b/sys-apps/nbd/files/digest-nbd-2.0-r1 new file mode 100644 index 000000000000..033cef0a7bf2 --- /dev/null +++ b/sys-apps/nbd/files/digest-nbd-2.0-r1 @@ -0,0 +1 @@ +MD5 8364e916d4464fbec2132709c67b868c nbd-2.0.tar.gz 26606 diff --git a/sys-apps/nbd/files/nbd-client.8 b/sys-apps/nbd/files/nbd-client.8 new file mode 100644 index 000000000000..1186212369ff --- /dev/null +++ b/sys-apps/nbd/files/nbd-client.8 @@ -0,0 +1,99 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "NBD-CLIENT" "8" "04 April 2004" "" "" +.SH NAME +nbd-client \- connect to a server running nbd-server(1), to use its exported block device +.SH SYNOPSIS + +\fBnbd-client\fR [ \fBbs=\fIblocksize\fB\fR ] \fB\fIhost\fB\fR \fB\fIport\fB\fR \fB\fInbd-device\fB\fR [ \fB-swap\fR ] + + +\fBnbd-client\fR \fB-d \fInbd-device\fB\fR + +.SH "DESCRIPTION" +.PP +This manual page documents briefly the +\fBnbd-client\fR command. +.PP +This manual page was written for the Debian GNU/Linux distribution +because the original program does not have a manual page. +.PP +With \fBnbd-client\fR, you can connect to a +server running \fBnbd-server\fR, thus using raw +diskspace from that server as a blockdevice on the local +client. +.PP +To do this, support from the Linux Kernel is necessary, in +the form of the Network Block Device (NBD). When you have that, +either in the kernel, or as a module, you can connect to an NBD +server and use its exported file through a block special file with +major mode 43. +.SH "OPTIONS" +.PP +The following options are supported: +.TP +\fBbs=\fIblocksize\fB\fR +Use a blocksize of "blocksize". Default is 1024; +allowed values are either 512, 1024, 2048 or 4096 +.TP +\fBhost\fR +The hostname of the machine running +\fBnbd-server\fR. +.TP +\fBport\fR +The TCP port on which \fBnbd-server\fR is +running at the server. +.TP +\fBnbd-device\fR +The block special file this nbd-client should connect +to. +.TP +\fB-swap\fR +Specifies that this NBD device will be used as +swapspace. If you intend to do that, please use this +option to prevent deadlocks. You'll need a special kernel +patch, available at NBD's homepage: +http://atrey.karlin.mff.cuni.cz/~pavel +.SH "EXAMPLES" +.PP +Some examples of nbd-client usage: +.TP 0.2i +\(bu +To connect to a server running on port 2000 at host +"server.domain.com", using the client's block special file +"/dev/nd0": + +\fBnbd-client 2000 server.domain.com +/dev/nd0\fR +.TP 0.2i +\(bu +To connect to a server running on port 2001 at host +"swapserver.domain.com", using the client's block special +file "/dev/nd1", for swap purposes: + +\fBnbd-client 2001 swapserver.domain.com /dev/nd1 +-swap\fR +.TP 0.2i +\(bu +To disconnect the above connection again (after making +sure the block special file is not in use anymore): + +\fBnbd-client -d /dev/nd1\fR +.SH "SEE ALSO" +.PP +nbd-server (1). +.SH "AUTHOR" +.PP +The NBD kernel module and the NBD tools have been written by +Pavel Macheck (pavel@ucw.cz). +.PP +This manual page was written by Wouter Verhelst (<wouter@debian.org>) for +the Debian GNU/Linux system (but may be used by others). Permission is +granted to copy, distribute and/or modify this document under the +terms of the GNU Free Documentation License, +Version 1.1 or any later version published by the Free Software +Foundation; with no Invariant Sections, no Front-Cover Texts and +no Back-Cover Texts. diff --git a/sys-apps/nbd/files/nbd-server.1 b/sys-apps/nbd/files/nbd-server.1 new file mode 100644 index 000000000000..b0da337fe7f7 --- /dev/null +++ b/sys-apps/nbd/files/nbd-server.1 @@ -0,0 +1,125 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "NBD-SERVER" "1" "04 April 2004" "" "" +.SH NAME +nbd-server \- serve a file as a block device to other computers running the GNU/Linux(tm) or GNU/Hurd Operating System +.SH SYNOPSIS + +\fBnbd-server\fR [ \fB-c \fIthis\fB\fR ] \fB\fIport\fB\fR \fB\fIfilename\fB\fR [ \fB\fIsize\fB\fR ] [ \fB-r\fR ] [ \fB-m\fR ] [ \fB-c\fR ] + +.SH "DESCRIPTION" +.PP +This manual page documents the +\fBnbd-server\fR command. +.PP +This manual page was written for the Debian GNU/Linux distribution +because the original program does not have a manual page. +.PP +\fBnbd-server\fR is the server for the Linux +Network Block Device (NBD). With NBD, a client can use a file, +exported over the network from a server, as a block device. It can +then be used for whatever purpose a normal block device (harddisk, +CD-ROM, ...) can be used for. +.PP +NBD can be usefull for diskless clients that need swapspace, +but you can also create a filesystem on it and use it as though it +were a local filesystem. +.PP +\fBnbd-server\fR implements some security +through a file called "nbd_server.allow" in the current directory. +This file must list the IP-addresses of clients that are allowed +to connect. If it does not exist, all clients are able to connect. +If the file is empty, no clients can connect. +.SH "OPTIONS" +.TP +\fBport \fR +The port the server should listen to. A valid port is +any number between 1 and 65536; if 0 is used, nbd-server +will listen on stdin (so that nbd-server can be ran from +inetd) +.TP +\fBfilename\fR +The filename of the file that should be exported. This +can be any file, including "real" blockdevices (i.e. a file +from /dev). If the filename includes the literal string +"%s", then this %s will be substituded with the IP-address +of the client trying to connect. +.TP +\fBsize\fR +The size of the block device at the client side. This +is especially usefull in conjunction with the -m +option + +Can optionally be followed by one of K,k,M or +m, in which case the size will be multiplied by 1024 (K +or k) or 1048576 (M or m) +.TP +\fB-r\fR +Export the file read-only. If a client tries to write +to a read-only exported file, it will receive an error, but +the connection will stay up. +.TP +\fB-m\fR +Work with multiple files. This can be used to export +blockdevices that are larger than the maximum allowed +filesize on a given filesystem; i.e. when the filesystem +does not allow files larger than 2GB (which is true for +Linux 2.2 and below), you can use this option to store the +data in multiple files and export a larger filesystem, if +needed. +.TP +\fB-c\fR +Copy on write. When this option is provided, +write-operations are not done to the exported file, but to a +separate file. This separate file is removed when the +connection is closed, which means that serving this way will +make nbd-server slow down (especially on large block devices +with lots of writes), and that after disconnecting and +reconnecting the client or the server, all changes are +lost. +.SH "EXAMPLES" +.PP +Some examples of nbd-server usage: +.TP 0.2i +\(bu +To export a file /export/nbd/exp-bl-dev on port 2000: + +\fBnbd-server 2000 /export/nbd/exp-bl-dev\fR +.TP 0.2i +\(bu +To export a the same file read-only: + +\fBnbd-server 2000 /export/nbd/exp-bl-dev -r\fR +.TP 0.2i +\(bu +To export the same file read-write, but make sure +changes are lost after restarting the client or the +server: + +\fBnbd-server 2000 /export/nbd/exp-bl-dev +-c\fR +.SH "FILES" +.TP +\fB\fInbd_server.allow\fB\fR +This file, which must be in the directory where +nbd-server is invoked, can contain a list of IP-addresses +for hosts that may connect to the server. Wildcards are +not allowed. +.SH "SEE ALSO" +.PP +nbd-client (8). +.SH "AUTHOR" +.PP +The NBD kernel module and the NBD tools were written by +Pavel Machek (pavel@ucw.cz) +.PP +This manual page was written by Wouter Verhelst (<wouter@debian.org>) for +the Debian GNU/Linux system (but may be used by others). Permission is +granted to copy, distribute and/or modify this document under +the terms of the GNU Free Documentation +License, Version 1.1 or any later version published by the Free +Software Foundation; with no Invariant Sections, no Front-Cover +Texts and no Back-Cover Texts. diff --git a/sys-apps/nbd/nbd-2.0-r1.ebuild b/sys-apps/nbd/nbd-2.0-r1.ebuild new file mode 100644 index 000000000000..f605bc5944c9 --- /dev/null +++ b/sys-apps/nbd/nbd-2.0-r1.ebuild @@ -0,0 +1,30 @@ +# Copyright 1999-2003 Gentoo Technologies, Inc. +# Distributed under the terms of the GNU General Public License v2 +# $Header: /var/cvsroot/gentoo-x86/sys-apps/nbd/nbd-2.0-r1.ebuild,v 1.1 2004/04/04 19:52:58 vapier Exp $ + +DESCRIPTION="Userland client/server for kernel network block device" +HOMEPAGE="http://nbd.sourceforge.net/" +SRC_URI="mirror://sourceforge/nbd/${P}.tar.gz" + +LICENSE="GPL-2" +SLOT="0" +KEYWORDS="x86 -ppc amd64" + +DEPEND="virtual/glibc" + +S=${WORKDIR}/${PN} + +src_compile() { + econf || die + make || die + make -C gznbd || die +} + +src_install() { + dodir /usr/bin + make install prefix=${D}/usr || die + dobin gznbd/gznbd || die + + doman ${FILESDIR}/nbd-client.8 ${FILESDIR}/nbd-server.1 + dodoc README +} |