Annotation of src/usr.sbin/puffs/mount_9p/mount_9p.8, Revision 1.17
1.17 ! uwe 1: .\" $NetBSD: mount_9p.8,v 1.16 2022/02/10 13:05:07 uwe Exp $
1.1 pooka 2: .\"
3: .\" Copyright (c) 2007 Antti Kantee. All rights reserved.
4: .\"
5: .\" Redistribution and use in source and binary forms, with or without
6: .\" modification, are permitted provided that the following conditions
7: .\" are met:
8: .\" 1. Redistributions of source code must retain the above copyright
9: .\" notice, this list of conditions and the following disclaimer.
10: .\" 2. Redistributions in binary form must reproduce the above copyright
11: .\" notice, this list of conditions and the following disclaimer in the
12: .\" documentation and/or other materials provided with the distribution.
13: .\"
14: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24: .\" SUCH DAMAGE.
25: .\"
1.17 ! uwe 26: .Dd February 10, 2022
1.1 pooka 27: .Dt MOUNT_9P 8
28: .Os
29: .Sh NAME
30: .Nm mount_9p
31: .Nd mount a file server using the 9P resource sharing protocol
32: .Sh SYNOPSIS
33: .Nm
1.16 uwe 34: .Op Fl 46Csu
1.13 uwe 35: .Op Fl o Ar options
1.2 pooka 36: .Op Fl p Ar port
1.13 uwe 37: .Oo Ar user Ns Li \&@ Oc Ns Ar host Ns Op Li \&: Ns Ar path
1.1 pooka 38: .Ar mount_point
1.11 ozaki-r 39: .Nm
40: .Fl c
1.16 uwe 41: .Op Fl Csu
1.13 uwe 42: .Op Fl o Ar options
43: .Ar device
1.11 ozaki-r 44: .Ar mount_point
1.1 pooka 45: .Sh DESCRIPTION
46: The
47: .Nm
1.4 wiz 48: program is used to mount a file hierarchy served with the Plan 9
1.13 uwe 49: resource sharing protocol 9P.
1.1 pooka 50: After the file system is mounted, the files on the remote
1.3 pooka 51: .Ar host
1.1 pooka 52: will be accessed using the credentials of the user named
53: .Ar user
1.4 wiz 54: and whatever UID the user happens to have on the remote server.
1.3 pooka 55: If
56: .Ar path
57: is supplied, it is used as the mount rootpath on the remote host.
58: .Ar path
59: must be an absolute path.
1.5 ozaki-r 60: .Pp
1.15 uwe 61: The host name may be optionally enclosed in square brackets.
62: This is required when using numeric IPv6 addresses as they contain
63: colons as part of their syntax.
64: .Pp
1.11 ozaki-r 65: The
66: .Fl c
1.13 uwe 67: option enables to mount a file system exported by a VM host through
1.11 ozaki-r 68: a character device file
1.13 uwe 69: .Ar device
1.11 ozaki-r 70: backed by the
71: .Xr vio9p 4
72: driver.
73: See
74: .Xr vio9p 4
75: for more information.
76: .Pp
1.13 uwe 77: The following options are available:
78: .Bl -tag -width "Fl o Ar options"
1.14 uwe 79: .It Fl 4
80: Forces
81: .Nm
82: to use IPv4 addresses only.
83: .It Fl 6
84: Forces
85: .Nm
86: to use IPv6 addresses only.
1.16 uwe 87: .It Fl C
88: Permit the kernel to cache pathname components.
89: By default every time the kernel does a lookup for a component name,
90: the file server will be consulted.
1.13 uwe 91: .It Fl c
92: Interpret
93: .Ar special
94: as a device name.
95: See
96: .Xr vio9p 4 .
97: .It Fl o Ar options
98: Mount options.
99: See documentation for the
100: .Fl o
101: option to
102: .Xr mount 8 .
103: .It Fl p Ar port
104: Use the specified TCP port.
1.5 ozaki-r 105: By default
106: .Nm
1.13 uwe 107: uses port 564
108: .Li ( 9pfs ) .
109: Another useful port is 6666
110: .Li ( styx ) ,
111: used by Inferno operating system.
112: .It Fl s
113: Run in the foreground.
114: Useful for debugging.
115: .It Fl u
116: Use 9P2000.u protocol that includes extensions to better support Unix
1.8 ozaki-r 117: environments.
1.13 uwe 118: .El
1.1 pooka 119: .Sh SEE ALSO
120: .Xr puffs 3 ,
121: .Xr puffs 4 ,
1.12 wiz 122: .Xr vio9p 4 ,
123: .Xr mount 8
1.6 ozaki-r 124: .Rs
1.13 uwe 125: .%T 9P: The Simple Distributed File System from Bell Labs
126: .%U http://9p.cat-v.org/
127: .Re
128: .Rs
1.6 ozaki-r 129: .%T RFC and standards documents relating the 9P protocol
130: .%U http://ericvh.github.io/9p-rfc/
1.7 wiz 131: .Re
1.1 pooka 132: .Sh HISTORY
133: The
134: .Nm
135: utility first appeared in
136: .Nx 5.0 .
1.8 ozaki-r 137: .Pp
138: Experimental 9P2000.u support appeared in
139: .Nx 9.0 .
1.11 ozaki-r 140: .Pp
141: The
1.13 uwe 142: .Xr vio9p 4
143: support appeared in
1.11 ozaki-r 144: .Nx 10.0 .
1.1 pooka 145: .Sh CAVEATS
1.13 uwe 146: Authentication is not supported.
147: .Pp
1.1 pooka 148: Permissions are not handled well.
149: .Pp
1.10 ozaki-r 150: Error code handling is missing for 9P2000.
1.1 pooka 151: .Pp
1.8 ozaki-r 152: 9P2000.u support doesn't use extension fields.
CVSweb <webmaster@jp.NetBSD.org>