Add myself for packaging copyright and some minor tweaks
[deb_libnfs.git] / doc / nfs-ls.1
1 '\" t
2 .\" Title: nfs-ls
3 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5 .\" Date: 05/14/2014
6 .\" Manual: nfs-ls: list servers, exports and directories
7 .\" Source: nfs-ls
8 .\" Language: English
9 .\"
10 .TH "NFS\-LS" "1" "05/14/2014" "nfs\-ls" "nfs\-ls: list servers, exports"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 nfs-ls \- Utility to list NFS servers, exports and directories
32 .SH "SYNOPSIS"
33 .HP \w'\fBnfs\-ls\ [\ OPTIONS\ ]\ <NFS\-URL>\fR\ 'u
34 \fBnfs\-ls [ OPTIONS ] <NFS\-URL>\fR
35 .HP \w'\fBnfs\-ls\fR\ 'u
36 \fBnfs\-ls\fR [\-R\ \-\-recursive] [\-s\ \-\-summary] [\-D\ \-\-discovery] [\-?\ \-\-help] [\-\-usage]
37 .SH "DESCRIPTION"
38 .PP
39 nfs\-ls is a utility to list NFS servers, exports or directories\&.
40 .PP
41 Example: List the content of a directory on the NFS server
42 .sp
43 .if n \{\
44 .RS 4
45 .\}
46 .nf
47 $ nfs\-ls nfs://127\&.0\&.0\&.1/data/tmp
48 \-rwxrwxr\-x 1 1000 1000 1190802 a\&.out
49 \-rwxr\-xr\-x 1 1000 1000 13 foo123\&.copy
50 \-rwxrwxrwx 1 1000 1000 8 foo123\&.writtenx
51
52 .fi
53 .if n \{\
54 .RE
55 .\}
56 .sp
57 .SH "OPTIONS"
58 .PP
59 \-s \-\-summary
60 .RS 4
61 Print a summary line at the end of output\&.
62 .RE
63 .PP
64 \-R \-\-recursive
65 .RS 4
66 Recursive listing of the specified URL\&.
67 .RE
68 .PP
69 \-D \-\-discovery;
70 .RS 4
71 This option is used to discover local NFS servers and to list the exports for specific servers\&.
72 .sp
73 When used with the \*(Aqnfs://\*(Aq URL the command will try to detect all local NFS servers and will list their IPs\&.
74 .sp
75 When used with a \*(Aqnfs://server\*(Aq the command will list all the exports on the specified server\&.
76 .sp
77 Example: Discover and list all local NFS servers
78 .sp
79 .if n \{\
80 .RS 4
81 .\}
82 .nf
83 $ nfs\-ls \-D nfs://
84 nfs://10\&.10\&.10\&.10
85 nfs://10\&.0\&.0\&.10
86
87 .fi
88 .if n \{\
89 .RE
90 .\}
91 .sp
92 Example: List the exports for a server
93 .sp
94 .if n \{\
95 .RS 4
96 .\}
97 .nf
98 $ nfs\-ls \-D nfs://10\&.10\&.10\&.10
99 nfs://10\&.10\&.10\&.10/foo
100 nfs://10\&.10\&.10\&.10/bar
101
102 .fi
103 .if n \{\
104 .RE
105 .\}
106 .sp
107 .RE
108 .PP
109 \-? \-\-help
110 .RS 4
111 Display basic help text\&.
112 .RE
113 .PP
114 \-\-usage
115 .RS 4
116 Display basic usage text\&.
117 .RE
118 .SH "SEE ALSO"
119 .PP
120 \m[blue]\fB\%http://github.com/sahlberg/libnfs\fR\m[]