source: postlfs/filesystems/sshfs.xml@ c4983db

trunk
Last change on this file since c4983db was c4983db, checked in by Douglas R. Reno <renodr@…>, 2 months ago

Package updates
Update to evince-40.2
Update to gnome-desktop-40.2
Update to xkeyboard-config-2.33
Update to sshfs-3.7.2

  • Property mode set to 100644
File size: 5.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY sshfs-download-http
8 "https://github.com/libfuse/sshfs/releases/download/sshfs-&sshfs-version;/sshfs-&sshfs-version;.tar.xz">
9 <!ENTITY sshfs-download-ftp " ">
10 <!ENTITY sshfs-md5sum "86dcc81a1381c3e6863c97e684501bb6">
11 <!ENTITY sshfs-size "52 KB">
12 <!ENTITY sshfs-buildsize "1.8 MB">
13 <!ENTITY sshfs-time "less than 0.1 SBU">
14]>
15
16<sect1 id="sshfs" xreflabel="sshfs-&sshfs-version;">
17 <?dbhtml filename="sshfs.html"?>
18
19 <sect1info>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>sshfs-&sshfs-version;</title>
24
25 <indexterm zone="sshfs">
26 <primary sortas="a-sshfs">sshfs</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Sshfs</title>
31
32 <para>
33 The <application>Sshfs</application> package contains a filesystem
34 client based on the SSH File Transfer Protocol. This is useful for
35 mounting a remote computer that you have ssh access to as a local
36 filesystem. This allows you to drag and drop files or run shell commands
37 on the remote files as if they were on your local computer.
38 </para>
39
40 &lfs101_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>
46 Download (HTTP): <ulink url="&sshfs-download-http;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download (FTP): <ulink url="&sshfs-download-ftp;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download MD5 sum: &sshfs-md5sum;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download size: &sshfs-size;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated disk space required: &sshfs-buildsize;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated build time: &sshfs-time;
72 </para>
73 </listitem>
74 </itemizedlist>
75
76 <bridgehead renderas="sect3">Sshfs Dependencies</bridgehead>
77
78 <bridgehead renderas="sect4">Required</bridgehead>
79 <para role="required">
80 <xref linkend="fuse3"/>,
81 <xref linkend="glib2"/>, and
82 <xref linkend="openssh"/>.
83 </para>
84
85 <bridgehead renderas="sect4">Optional</bridgehead>
86 <para role="optional">
87 <xref linkend="docutils"/> (required to build the man page)
88 </para>
89
90 <para condition="html" role="usernotes">
91 User Notes: <ulink url="&blfs-wiki;/sshfs"/>
92 </para>
93 </sect2>
94
95 <sect2 role="installation">
96 <title>Installation of Sshfs</title>
97
98 <para>
99 Install <application>Sshfs</application> by running the following
100 commands:
101 </para>
102
103 <screen><userinput>mkdir build &amp;&amp;
104cd build &amp;&amp;
105
106meson --prefix=/usr .. &amp;&amp;
107ninja</userinput></screen>
108
109 <para>
110 This package does not come with a test suite.
111 </para>
112
113 <para>
114 Now, as the <systemitem class="username">root</systemitem> user:
115 </para>
116
117<screen role="root"><userinput>ninja install</userinput></screen>
118 </sect2>
119
120 <sect2 role="using">
121 <title>Using Sshfs</title>
122
123 <para>
124 To mount an ssh server you need to be able to log into the server. For
125 example, to mount your remote home folder to the local ~/examplepath (the
126 directory must exist and you must have permissions to write to it):
127 </para>
128
129<screen><userinput>sshfs example.com:/home/userid ~/examplepath</userinput></screen>
130
131 <para>
132 When you've finished work and want to unmount it again:
133 </para>
134
135<screen><userinput>fusermount3 -u ~/example</userinput></screen>
136
137 <para>
138 You can also mount an <application>sshfs</application> filesystem at boot
139 by adding an entry similar to the following in the
140 <filename>/etc/fstab</filename> file:
141 </para>
142
143 <screen><literal>userid@example.com:/path /media/path fuse.sshfs _netdev,IdentityFile=/home/userid/.ssh/id_rsa 0 0</literal></screen>
144
145 <para>
146 See <command>man 1 sshfs</command> and <command>man 8 mount.fuse</command>
147 for all available mount options.
148 </para>
149
150 </sect2>
151
152 <sect2 role="content">
153 <title>Contents</title>
154
155 <segmentedlist>
156 <segtitle>Installed Program</segtitle>
157 <segtitle>Installed Libraries</segtitle>
158 <segtitle>Installed Directories</segtitle>
159
160 <seglistitem>
161 <seg>
162 sshfs
163 </seg>
164 <seg>
165 None
166 </seg>
167 <seg>
168 None
169 </seg>
170 </seglistitem>
171 </segmentedlist>
172
173 <variablelist>
174 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
175 <?dbfo list-presentation="list"?>
176 <?dbhtml list-presentation="table"?>
177
178 <varlistentry id="sshfs-prog">
179 <term><command>sshfs</command></term>
180 <listitem>
181 <para>
182 mounts an <command>ssh</command> server as a local file system
183 </para>
184 <indexterm zone="sshfs sshfs-prog">
185 <primary sortas="b-sshfs">sshfs</primary>
186 </indexterm>
187 </listitem>
188 </varlistentry>
189 </variablelist>
190 </sect2>
191
192</sect1>
Note: See TracBrowser for help on using the repository browser.