| 1 | <?xml version="1.0" encoding="iso-8859-1"?> |
| 2 | <refentry id="nfs-ls.1"> |
| 3 | |
| 4 | <refmeta> |
| 5 | <refentrytitle>nfs-ls</refentrytitle> |
| 6 | <manvolnum>1</manvolnum> |
| 7 | <refmiscinfo class="source">nfs-ls</refmiscinfo> |
| 8 | <refmiscinfo class="manual">nfs-ls: list servers, exports and directories</refmiscinfo> |
| 9 | </refmeta> |
| 10 | |
| 11 | |
| 12 | <refnamediv> |
| 13 | <refname>nfs-ls</refname> |
| 14 | <refpurpose>Utility to list NFS servers, exports and directories</refpurpose> |
| 15 | </refnamediv> |
| 16 | |
| 17 | <refsynopsisdiv> |
| 18 | <cmdsynopsis> |
| 19 | <command>nfs-ls [ OPTIONS ] <NFS-URL></command> |
| 20 | </cmdsynopsis> |
| 21 | |
| 22 | <cmdsynopsis> |
| 23 | <command>nfs-ls</command> |
| 24 | <arg choice="opt">-R --recursive</arg> |
| 25 | <arg choice="opt">-s --summary</arg> |
| 26 | <arg choice="opt">-D --discovery</arg> |
| 27 | <arg choice="opt">-? --help</arg> |
| 28 | <arg choice="opt">--usage</arg> |
| 29 | </cmdsynopsis> |
| 30 | |
| 31 | </refsynopsisdiv> |
| 32 | |
| 33 | <refsect1><title>DESCRIPTION</title> |
| 34 | <para> |
| 35 | nfs-ls is a utility to list NFS servers, exports or directories. |
| 36 | </para> |
| 37 | <para> |
| 38 | Example: List the content of a directory on the NFS server |
| 39 | <screen format="linespecific"> |
| 40 | $ nfs-ls nfs://127.0.0.1/data/tmp |
| 41 | -rwxrwxr-x 1 1000 1000 1190802 a.out |
| 42 | -rwxr-xr-x 1 1000 1000 13 foo123.copy |
| 43 | -rwxrwxrwx 1 1000 1000 8 foo123.writtenx |
| 44 | </screen> |
| 45 | </para> |
| 46 | </refsect1> |
| 47 | |
| 48 | <refsect1> |
| 49 | <title>OPTIONS</title> |
| 50 | |
| 51 | <variablelist> |
| 52 | |
| 53 | <varlistentry><term>-s --summary</term> |
| 54 | <listitem> |
| 55 | <para> |
| 56 | Print a summary line at the end of output. |
| 57 | </para> |
| 58 | </listitem> |
| 59 | </varlistentry> |
| 60 | |
| 61 | <varlistentry><term>-R --recursive</term> |
| 62 | <listitem> |
| 63 | <para> |
| 64 | Recursive listing of the specified URL. |
| 65 | </para> |
| 66 | </listitem> |
| 67 | </varlistentry> |
| 68 | |
| 69 | <varlistentry><term>-D --discovery;</term> |
| 70 | <listitem> |
| 71 | <para> |
| 72 | This option is used to discover local NFS servers and to list |
| 73 | the exports for specific servers. |
| 74 | </para> |
| 75 | <para> |
| 76 | When used with the 'nfs://' URL the command will try to |
| 77 | detect all local NFS servers and will list their IPs. |
| 78 | </para> |
| 79 | <para> |
| 80 | When used with a 'nfs://server' the command will |
| 81 | list all the exports on the specified server. |
| 82 | </para> |
| 83 | <para> |
| 84 | Example: Discover and list all local NFS servers |
| 85 | <screen format="linespecific"> |
| 86 | $ nfs-ls -D nfs:// |
| 87 | nfs://10.10.10.10 |
| 88 | nfs://10.0.0.10 |
| 89 | </screen> |
| 90 | |
| 91 | Example: List the exports for a server |
| 92 | <screen format="linespecific"> |
| 93 | $ nfs-ls -D nfs://10.10.10.10 |
| 94 | nfs://10.10.10.10/foo |
| 95 | nfs://10.10.10.10/bar |
| 96 | </screen> |
| 97 | </para> |
| 98 | </listitem> |
| 99 | </varlistentry> |
| 100 | |
| 101 | <varlistentry><term>-? --help</term> |
| 102 | <listitem> |
| 103 | <para> |
| 104 | Display basic help text. |
| 105 | </para> |
| 106 | </listitem> |
| 107 | </varlistentry> |
| 108 | |
| 109 | <varlistentry><term>--usage</term> |
| 110 | <listitem> |
| 111 | <para> |
| 112 | Display basic usage text. |
| 113 | </para> |
| 114 | </listitem> |
| 115 | </varlistentry> |
| 116 | |
| 117 | </variablelist> |
| 118 | </refsect1> |
| 119 | |
| 120 | <refsect1><title>SEE ALSO</title> |
| 121 | <para> |
| 122 | <ulink url="http://github.com/sahlberg/libnfs"/> |
| 123 | </para> |
| 124 | </refsect1> |
| 125 | |
| 126 | </refentry> |