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 ncftp-download-http " ">
|
---|
8 | <!ENTITY ncftp-download-ftp "ftp://ftp.ncftp.com/ncftp/ncftp-&ncftp-version;-src.tar.xz">
|
---|
9 | <!ENTITY ncftp-md5sum "42d0f896d69a4d603ec097546444245f">
|
---|
10 | <!ENTITY ncftp-size "412 KB">
|
---|
11 | <!ENTITY ncftp-buildsize "6.6 MB">
|
---|
12 | <!ENTITY ncftp-time "0.2 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="ncftp" xreflabel="NcFTP-&ncftp-version;">
|
---|
16 | <?dbhtml filename="ncftp.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>NcFTP-&ncftp-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="ncftp">
|
---|
22 | <primary sortas="a-NcFTP">NcFTP</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to NcFTP</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>NcFTP</application> package contains
|
---|
30 | a powerful and flexible interface to the Internet standard File Transfer
|
---|
31 | Protocol. It is intended to replace or supplement the stock
|
---|
32 | <command>ftp</command> program.
|
---|
33 | </para>
|
---|
34 |
|
---|
35 | &lfs120_checked;
|
---|
36 |
|
---|
37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
38 | <itemizedlist spacing="compact">
|
---|
39 | <listitem>
|
---|
40 | <para>
|
---|
41 | Download (HTTP): <ulink url="&ncftp-download-http;"/>
|
---|
42 | </para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>
|
---|
46 | Download (FTP): <ulink url="&ncftp-download-ftp;"/>
|
---|
47 | </para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>
|
---|
51 | Download MD5 sum: &ncftp-md5sum;
|
---|
52 | </para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>
|
---|
56 | Download size: &ncftp-size;
|
---|
57 | </para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>
|
---|
61 | Estimated disk space required: &ncftp-buildsize;
|
---|
62 | </para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Estimated build time: &ncftp-time;
|
---|
67 | </para>
|
---|
68 | </listitem>
|
---|
69 | </itemizedlist>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
72 | <itemizedlist spacing="compact">
|
---|
73 | <listitem>
|
---|
74 | <para>
|
---|
75 | Required patch:
|
---|
76 | <ulink url="&patch-root;/ncftp-&ncftp-version;-configure_fixes-1.patch"/>
|
---|
77 | </para>
|
---|
78 | </listitem>
|
---|
79 | </itemizedlist>
|
---|
80 |
|
---|
81 | <bridgehead renderas="sect3">NcFTP Dependencies</bridgehead>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
84 | <para role="optional">
|
---|
85 | <xref linkend="llvm"/> (with Clang, used by default if installed)
|
---|
86 | </para>
|
---|
87 |
|
---|
88 | </sect2>
|
---|
89 |
|
---|
90 | <sect2 role="installation">
|
---|
91 | <title>Installation of NcFTP</title>
|
---|
92 |
|
---|
93 | <para>
|
---|
94 | There are two ways to build <application>NcFTP</application>. The first
|
---|
95 | (and optimal) way builds most of the functionality as a shared library
|
---|
96 | and then builds and installs the program linked against this library.
|
---|
97 | The second method simply links all of the functionality into the binary
|
---|
98 | statically. This doesn't make the dynamic library available for linking
|
---|
99 | by other applications. You need to choose which method best suits you.
|
---|
100 | Note that the second method does <emphasis>not</emphasis> create an
|
---|
101 | entirely statically linked binary; only the <filename
|
---|
102 | class="libraryfile">libncftp</filename> parts are statically linked in,
|
---|
103 | in this case. Be aware that building and using the shared library is
|
---|
104 | covered by the Clarified Artistic License; however, developing
|
---|
105 | applications that utilize the shared library is subject to a different
|
---|
106 | license.
|
---|
107 | </para>
|
---|
108 |
|
---|
109 | <para>
|
---|
110 | First, fix an issue caused by a change in behavior in GCC-10:
|
---|
111 | </para>
|
---|
112 |
|
---|
113 | <screen><userinput remap="pre">sed -i 's/^Bookmark/extern Bookmark/' sh_util/gpshare.c</userinput></screen>
|
---|
114 |
|
---|
115 | <para>
|
---|
116 | Next, update the configure script to use modern C standards:
|
---|
117 | </para>
|
---|
118 |
|
---|
119 | <screen><userinput remap="pre">patch -Np1 -i ../ncftp-&ncftp-version;-configure_fixes-1.patch &&
|
---|
120 | autoreconf -fiv -I autoconf_local</userinput></screen>
|
---|
121 |
|
---|
122 | <para>
|
---|
123 | To install <application>NcFTP</application> using the
|
---|
124 | first (and optimal) method, run the following commands:
|
---|
125 | </para>
|
---|
126 |
|
---|
127 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
128 | make -C libncftp shared &&
|
---|
129 | make</userinput></screen>
|
---|
130 |
|
---|
131 | <para>
|
---|
132 | This package does not come with a test suite.
|
---|
133 | </para>
|
---|
134 |
|
---|
135 | <para>
|
---|
136 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
137 | </para>
|
---|
138 |
|
---|
139 | <screen role='root'><userinput>make -C libncftp soinstall &&
|
---|
140 | make install</userinput></screen>
|
---|
141 |
|
---|
142 | <para>
|
---|
143 | To install <application>NcFTP</application> using the
|
---|
144 | second method (with the <filename class="libraryfile">libncftp</filename>
|
---|
145 | functionality linked in statically) run the following commands:
|
---|
146 | </para>
|
---|
147 |
|
---|
148 | <screen role="nodump"><userinput>./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
149 | make</userinput></screen>
|
---|
150 |
|
---|
151 | <para>
|
---|
152 | This package does not come with a test suite.
|
---|
153 | </para>
|
---|
154 |
|
---|
155 | <para>
|
---|
156 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
157 | </para>
|
---|
158 |
|
---|
159 | <screen role="nodump"><userinput>make install</userinput></screen>
|
---|
160 |
|
---|
161 | </sect2>
|
---|
162 |
|
---|
163 | <sect2 role="commands">
|
---|
164 | <title>Command Explanations</title>
|
---|
165 |
|
---|
166 | <para>
|
---|
167 | <command>make -C ... && make -C ...</command>:
|
---|
168 | These commands make and install the dynamic library <filename
|
---|
169 | class="libraryfile">libncftp</filename> which is then used to link
|
---|
170 | against when compiling the main program.
|
---|
171 | </para>
|
---|
172 |
|
---|
173 | </sect2>
|
---|
174 |
|
---|
175 | <sect2 role="configuration">
|
---|
176 | <title>Configuring NcFTP</title>
|
---|
177 |
|
---|
178 | <sect3 id="ncftp-config">
|
---|
179 | <title>Config Files</title>
|
---|
180 |
|
---|
181 | <para>
|
---|
182 | <filename>/etc/ncftp.*</filename> and
|
---|
183 | <filename>~/.ncftp/*</filename>; especially
|
---|
184 | <filename>/etc/ncftp.prefs_v3</filename> and
|
---|
185 | <filename>~/.ncftp/prefs_v3</filename>
|
---|
186 | </para>
|
---|
187 |
|
---|
188 | <indexterm zone="ncftp ncftp-config">
|
---|
189 | <primary sortas="e-AA.ncftp/*">~/.ncftp/*</primary>
|
---|
190 | </indexterm>
|
---|
191 |
|
---|
192 | <indexterm zone="ncftp ncftp-config">
|
---|
193 | <primary sortas="e-etc-ncftp.*">/etc/ncftp.*</primary>
|
---|
194 | </indexterm>
|
---|
195 |
|
---|
196 | </sect3>
|
---|
197 |
|
---|
198 | <sect3>
|
---|
199 | <title>Configuration Information</title>
|
---|
200 |
|
---|
201 | <para>
|
---|
202 | Most <application>NcFTP</application> configuration is done while in
|
---|
203 | the program, and the configuration files are dealt with automatically.
|
---|
204 | One exception to this is <filename>~/.ncftp/prefs_v3</filename>. There
|
---|
205 | are various options to alter in there, including:
|
---|
206 | </para>
|
---|
207 |
|
---|
208 | <screen><literal>yes-i-know-about-NcFTPd=yes</literal></screen>
|
---|
209 |
|
---|
210 | <para>
|
---|
211 | This disables the splash screen advertising the
|
---|
212 | <application>NcFTPd</application> server.
|
---|
213 | </para>
|
---|
214 |
|
---|
215 | <para>
|
---|
216 | There are other options in the <filename>prefs_v3</filename> file.
|
---|
217 | Most of these are self-explanatory. Global defaults can be set in
|
---|
218 | <filename>/etc/ncftp.prefs_v3</filename>.
|
---|
219 | </para>
|
---|
220 |
|
---|
221 | </sect3>
|
---|
222 |
|
---|
223 | </sect2>
|
---|
224 |
|
---|
225 | <sect2 role="content">
|
---|
226 | <title>Contents</title>
|
---|
227 |
|
---|
228 | <segmentedlist>
|
---|
229 | <segtitle>Installed Programs</segtitle>
|
---|
230 | <segtitle>Installed Library</segtitle>
|
---|
231 | <segtitle>Installed Directories</segtitle>
|
---|
232 |
|
---|
233 | <seglistitem>
|
---|
234 | <seg>ncftp, ncftpbatch, ncftpbookmarks, ncftpget,
|
---|
235 | ncftpls, ncftpput, and ncftpspooler</seg>
|
---|
236 | <seg>libncftp.so</seg>
|
---|
237 | <seg>None</seg>
|
---|
238 | </seglistitem>
|
---|
239 | </segmentedlist>
|
---|
240 |
|
---|
241 | <variablelist>
|
---|
242 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
243 | <?dbfo list-presentation="list"?>
|
---|
244 | <?dbhtml list-presentation="table"?>
|
---|
245 |
|
---|
246 | <varlistentry id="ncftp-prog">
|
---|
247 | <term><command>ncftp</command></term>
|
---|
248 | <listitem>
|
---|
249 | <para>
|
---|
250 | is a browser program for File Transfer Protocol
|
---|
251 | </para>
|
---|
252 | <indexterm zone="ncftp ncftp-prog">
|
---|
253 | <primary sortas="b-ncftp">ncftp</primary>
|
---|
254 | </indexterm>
|
---|
255 | </listitem>
|
---|
256 | </varlistentry>
|
---|
257 |
|
---|
258 | <varlistentry id="ncftpbatch">
|
---|
259 | <term><command>ncftpbatch</command></term>
|
---|
260 | <listitem>
|
---|
261 | <para>
|
---|
262 | is an individual batch FTP job processor
|
---|
263 | </para>
|
---|
264 | <indexterm zone="ncftp ncftpbatch">
|
---|
265 | <primary sortas="b-ncftpbatch">ncftpbatch</primary>
|
---|
266 | </indexterm>
|
---|
267 | </listitem>
|
---|
268 | </varlistentry>
|
---|
269 |
|
---|
270 | <varlistentry id="ncftpbookmarks">
|
---|
271 | <term><command>ncftpbookmarks</command></term>
|
---|
272 | <listitem>
|
---|
273 | <para>
|
---|
274 | is the <application>NcFTP</application> Bookmark Editor
|
---|
275 | (<application>NCurses</application>-based)
|
---|
276 | </para>
|
---|
277 | <indexterm zone="ncftp ncftpbookmarks">
|
---|
278 | <primary sortas="b-ncftpbookmarks">ncftpbookmarks</primary>
|
---|
279 | </indexterm>
|
---|
280 | </listitem>
|
---|
281 | </varlistentry>
|
---|
282 |
|
---|
283 | <varlistentry id="ncftpget">
|
---|
284 | <term><command>ncftpget</command></term>
|
---|
285 | <listitem>
|
---|
286 | <para>
|
---|
287 | is an internet file transfer program for scripts used to
|
---|
288 | retrieve files
|
---|
289 | </para>
|
---|
290 | <indexterm zone="ncftp ncftpget">
|
---|
291 | <primary sortas="b-ncftpget">ncftpget</primary>
|
---|
292 | </indexterm>
|
---|
293 | </listitem>
|
---|
294 | </varlistentry>
|
---|
295 |
|
---|
296 | <varlistentry id="ncftpls">
|
---|
297 | <term><command>ncftpls</command></term>
|
---|
298 | <listitem>
|
---|
299 | <para>
|
---|
300 | is an internet file transfer program for scripts used to
|
---|
301 | list files
|
---|
302 | </para>
|
---|
303 | <indexterm zone="ncftp ncftpls">
|
---|
304 | <primary sortas="b-ncftpls">ncftpls</primary>
|
---|
305 | </indexterm>
|
---|
306 | </listitem>
|
---|
307 | </varlistentry>
|
---|
308 |
|
---|
309 | <varlistentry id="ncftpput">
|
---|
310 | <term><command>ncftpput</command></term>
|
---|
311 | <listitem>
|
---|
312 | <para>
|
---|
313 | is an internet file transfer program for scripts used to
|
---|
314 | transfer files
|
---|
315 | </para>
|
---|
316 | <indexterm zone="ncftp ncftpput">
|
---|
317 | <primary sortas="b-ncftpput">ncftpput</primary>
|
---|
318 | </indexterm>
|
---|
319 | </listitem>
|
---|
320 | </varlistentry>
|
---|
321 |
|
---|
322 | <varlistentry id="ncftpspooler">
|
---|
323 | <term><command>ncftpspooler</command></term>
|
---|
324 | <listitem>
|
---|
325 | <para>
|
---|
326 | is a global batch FTP job processor daemon
|
---|
327 | </para>
|
---|
328 | <indexterm zone="ncftp ncftpspooler">
|
---|
329 | <primary sortas="b-ncftpspooler">ncftpspooler</primary>
|
---|
330 | </indexterm>
|
---|
331 | </listitem>
|
---|
332 | </varlistentry>
|
---|
333 |
|
---|
334 | </variablelist>
|
---|
335 |
|
---|
336 | </sect2>
|
---|
337 |
|
---|
338 | </sect1>
|
---|