[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[d47e7ea9] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[600f3e1] | 7 | <!ENTITY ncftp-download-http "https://www.ncftp.com/downloads/ncftp/ncftp-&ncftp-version;-src.tar.xz">
|
---|
[e1e58be] | 8 | <!ENTITY ncftp-download-ftp " ">
|
---|
[e137dc2] | 9 | <!ENTITY ncftp-md5sum "bbcb048d2412f4d62bc798818e703680">
|
---|
| 10 | <!ENTITY ncftp-size "416 KB">
|
---|
| 11 | <!ENTITY ncftp-buildsize "6.9 MB">
|
---|
[6f8ecea] | 12 | <!ENTITY ncftp-time "0.2 SBU">
|
---|
[d47e7ea9] | 13 | ]>
|
---|
| 14 |
|
---|
[377584f] | 15 | <sect1 id="ncftp" xreflabel="NcFTP-&ncftp-version;">
|
---|
[ef3ec45] | 16 | <?dbhtml filename="ncftp.html"?>
|
---|
[bab92281] | 17 |
|
---|
| 18 |
|
---|
[377584f] | 19 | <title>NcFTP-&ncftp-version;</title>
|
---|
[bab92281] | 20 |
|
---|
[ef3ec45] | 21 | <indexterm zone="ncftp">
|
---|
| 22 | <primary sortas="a-NcFTP">NcFTP</primary>
|
---|
| 23 | </indexterm>
|
---|
[bab92281] | 24 |
|
---|
[ef3ec45] | 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to NcFTP</title>
|
---|
| 27 |
|
---|
[b51fe6e] | 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>
|
---|
[bab92281] | 34 |
|
---|
[a73fc762] | 35 | &lfs120_checked;
|
---|
[00555b0f] | 36 |
|
---|
[ef3ec45] | 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
[b51fe6e] | 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&ncftp-download-http;"/>
|
---|
| 42 | </para>
|
---|
[ef3ec45] | 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
[b51fe6e] | 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&ncftp-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
[ef3ec45] | 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
[b51fe6e] | 50 | <para>
|
---|
| 51 | Download MD5 sum: &ncftp-md5sum;
|
---|
| 52 | </para>
|
---|
[ef3ec45] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[b51fe6e] | 55 | <para>
|
---|
| 56 | Download size: &ncftp-size;
|
---|
| 57 | </para>
|
---|
[ef3ec45] | 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
[b51fe6e] | 60 | <para>
|
---|
| 61 | Estimated disk space required: &ncftp-buildsize;
|
---|
| 62 | </para>
|
---|
[ef3ec45] | 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
[b51fe6e] | 65 | <para>
|
---|
| 66 | Estimated build time: &ncftp-time;
|
---|
| 67 | </para>
|
---|
[2174baa] | 68 | </listitem>
|
---|
[ef3ec45] | 69 | </itemizedlist>
|
---|
[e137dc2] | 70 | <!--
|
---|
[c1e25d1] | 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 |
|
---|
[e54d2e5] | 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>
|
---|
[e137dc2] | 87 | -->
|
---|
[ef3ec45] | 88 | </sect2>
|
---|
[bab92281] | 89 |
|
---|
[ef3ec45] | 90 | <sect2 role="installation">
|
---|
| 91 | <title>Installation of NcFTP</title>
|
---|
| 92 |
|
---|
[b51fe6e] | 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>
|
---|
[e137dc2] | 108 | <!--
|
---|
[668c07b] | 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 |
|
---|
[c1e25d1] | 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>
|
---|
[e137dc2] | 121 | -->
|
---|
[b51fe6e] | 122 | <para>
|
---|
| 123 | To install <application>NcFTP</application> using the
|
---|
| 124 | first (and optimal) method, run the following commands:
|
---|
| 125 | </para>
|
---|
[ef3ec45] | 126 |
|
---|
[e137dc2] | 127 | <screen><userinput>CC=/usr/bin/gcc \
|
---|
| 128 | ./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
[6f8ecea] | 129 | make -C libncftp shared &&
|
---|
| 130 | make</userinput></screen>
|
---|
[108485b3] | 131 |
|
---|
[b51fe6e] | 132 | <para>
|
---|
| 133 | This package does not come with a test suite.
|
---|
| 134 | </para>
|
---|
[108485b3] | 135 |
|
---|
[b51fe6e] | 136 | <para>
|
---|
| 137 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 138 | </para>
|
---|
[108485b3] | 139 |
|
---|
[6f8ecea] | 140 | <screen role='root'><userinput>make -C libncftp soinstall &&
|
---|
| 141 | make install</userinput></screen>
|
---|
[d47e7ea9] | 142 |
|
---|
[b51fe6e] | 143 | <para>
|
---|
| 144 | To install <application>NcFTP</application> using the
|
---|
| 145 | second method (with the <filename class="libraryfile">libncftp</filename>
|
---|
| 146 | functionality linked in statically) run the following commands:
|
---|
| 147 | </para>
|
---|
[d47e7ea9] | 148 |
|
---|
[f67554b0] | 149 | <screen role="nodump"><userinput>./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
[108485b3] | 150 | make</userinput></screen>
|
---|
| 151 |
|
---|
[b51fe6e] | 152 | <para>
|
---|
| 153 | This package does not come with a test suite.
|
---|
| 154 | </para>
|
---|
[6f8ecea] | 155 |
|
---|
[b51fe6e] | 156 | <para>
|
---|
| 157 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 158 | </para>
|
---|
[108485b3] | 159 |
|
---|
[f67554b0] | 160 | <screen role="nodump"><userinput>make install</userinput></screen>
|
---|
[bab92281] | 161 |
|
---|
[ef3ec45] | 162 | </sect2>
|
---|
[bab92281] | 163 |
|
---|
[ef3ec45] | 164 | <sect2 role="commands">
|
---|
| 165 | <title>Command Explanations</title>
|
---|
| 166 |
|
---|
[e137dc2] | 167 | <para>
|
---|
| 168 | <envar>CC=/usr/bin/gcc</envar>. This environment variable ensures
|
---|
| 169 | that <command>gcc</command> is used if <xref linkend="llvm"/> is
|
---|
| 170 | installed. The build procedure is broken if <command>gcc</command>
|
---|
| 171 | is not used.
|
---|
| 172 | </para>
|
---|
| 173 |
|
---|
[b51fe6e] | 174 | <para>
|
---|
| 175 | <command>make -C ... && make -C ...</command>:
|
---|
| 176 | These commands make and install the dynamic library <filename
|
---|
| 177 | class="libraryfile">libncftp</filename> which is then used to link
|
---|
| 178 | against when compiling the main program.
|
---|
| 179 | </para>
|
---|
[bab92281] | 180 |
|
---|
[ef3ec45] | 181 | </sect2>
|
---|
[bab92281] | 182 |
|
---|
[ef3ec45] | 183 | <sect2 role="configuration">
|
---|
| 184 | <title>Configuring NcFTP</title>
|
---|
[bab92281] | 185 |
|
---|
[ef3ec45] | 186 | <sect3 id="ncftp-config">
|
---|
| 187 | <title>Config Files</title>
|
---|
[bab92281] | 188 |
|
---|
[b51fe6e] | 189 | <para>
|
---|
| 190 | <filename>/etc/ncftp.*</filename> and
|
---|
| 191 | <filename>~/.ncftp/*</filename>; especially
|
---|
| 192 | <filename>/etc/ncftp.prefs_v3</filename> and
|
---|
| 193 | <filename>~/.ncftp/prefs_v3</filename>
|
---|
| 194 | </para>
|
---|
[bab92281] | 195 |
|
---|
[ef3ec45] | 196 | <indexterm zone="ncftp ncftp-config">
|
---|
| 197 | <primary sortas="e-AA.ncftp/*">~/.ncftp/*</primary>
|
---|
| 198 | </indexterm>
|
---|
[bab92281] | 199 |
|
---|
[6f8ecea] | 200 | <indexterm zone="ncftp ncftp-config">
|
---|
| 201 | <primary sortas="e-etc-ncftp.*">/etc/ncftp.*</primary>
|
---|
| 202 | </indexterm>
|
---|
| 203 |
|
---|
[ef3ec45] | 204 | </sect3>
|
---|
[bab92281] | 205 |
|
---|
[ef3ec45] | 206 | <sect3>
|
---|
| 207 | <title>Configuration Information</title>
|
---|
| 208 |
|
---|
[b51fe6e] | 209 | <para>
|
---|
| 210 | Most <application>NcFTP</application> configuration is done while in
|
---|
| 211 | the program, and the configuration files are dealt with automatically.
|
---|
| 212 | One exception to this is <filename>~/.ncftp/prefs_v3</filename>. There
|
---|
| 213 | are various options to alter in there, including:
|
---|
| 214 | </para>
|
---|
[ef3ec45] | 215 |
|
---|
[bab92281] | 216 | <screen><literal>yes-i-know-about-NcFTPd=yes</literal></screen>
|
---|
[ef3ec45] | 217 |
|
---|
[b51fe6e] | 218 | <para>
|
---|
| 219 | This disables the splash screen advertising the
|
---|
| 220 | <application>NcFTPd</application> server.
|
---|
| 221 | </para>
|
---|
[bab92281] | 222 |
|
---|
[b51fe6e] | 223 | <para>
|
---|
| 224 | There are other options in the <filename>prefs_v3</filename> file.
|
---|
| 225 | Most of these are self-explanatory. Global defaults can be set in
|
---|
| 226 | <filename>/etc/ncftp.prefs_v3</filename>.
|
---|
| 227 | </para>
|
---|
[bab92281] | 228 |
|
---|
[ef3ec45] | 229 | </sect3>
|
---|
[bab92281] | 230 |
|
---|
[ef3ec45] | 231 | </sect2>
|
---|
[bab92281] | 232 |
|
---|
[ef3ec45] | 233 | <sect2 role="content">
|
---|
| 234 | <title>Contents</title>
|
---|
[bab92281] | 235 |
|
---|
[ef3ec45] | 236 | <segmentedlist>
|
---|
| 237 | <segtitle>Installed Programs</segtitle>
|
---|
| 238 | <segtitle>Installed Library</segtitle>
|
---|
| 239 | <segtitle>Installed Directories</segtitle>
|
---|
[bab92281] | 240 |
|
---|
[ef3ec45] | 241 | <seglistitem>
|
---|
| 242 | <seg>ncftp, ncftpbatch, ncftpbookmarks, ncftpget,
|
---|
| 243 | ncftpls, ncftpput, and ncftpspooler</seg>
|
---|
[108485b3] | 244 | <seg>libncftp.so</seg>
|
---|
| 245 | <seg>None</seg>
|
---|
[ef3ec45] | 246 | </seglistitem>
|
---|
| 247 | </segmentedlist>
|
---|
[bab92281] | 248 |
|
---|
[ef3ec45] | 249 | <variablelist>
|
---|
| 250 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 251 | <?dbfo list-presentation="list"?>
|
---|
| 252 | <?dbhtml list-presentation="table"?>
|
---|
[bab92281] | 253 |
|
---|
[ef3ec45] | 254 | <varlistentry id="ncftp-prog">
|
---|
| 255 | <term><command>ncftp</command></term>
|
---|
| 256 | <listitem>
|
---|
[b51fe6e] | 257 | <para>
|
---|
[4c24eb0a] | 258 | is a browser program for File Transfer Protocol
|
---|
[b51fe6e] | 259 | </para>
|
---|
[ef3ec45] | 260 | <indexterm zone="ncftp ncftp-prog">
|
---|
| 261 | <primary sortas="b-ncftp">ncftp</primary>
|
---|
| 262 | </indexterm>
|
---|
| 263 | </listitem>
|
---|
| 264 | </varlistentry>
|
---|
[bab92281] | 265 |
|
---|
[ef3ec45] | 266 | <varlistentry id="ncftpbatch">
|
---|
| 267 | <term><command>ncftpbatch</command></term>
|
---|
| 268 | <listitem>
|
---|
[b51fe6e] | 269 | <para>
|
---|
[4c24eb0a] | 270 | is an individual batch FTP job processor
|
---|
[b51fe6e] | 271 | </para>
|
---|
[ef3ec45] | 272 | <indexterm zone="ncftp ncftpbatch">
|
---|
| 273 | <primary sortas="b-ncftpbatch">ncftpbatch</primary>
|
---|
| 274 | </indexterm>
|
---|
| 275 | </listitem>
|
---|
| 276 | </varlistentry>
|
---|
[bab92281] | 277 |
|
---|
[ef3ec45] | 278 | <varlistentry id="ncftpbookmarks">
|
---|
| 279 | <term><command>ncftpbookmarks</command></term>
|
---|
| 280 | <listitem>
|
---|
[b51fe6e] | 281 | <para>
|
---|
| 282 | is the <application>NcFTP</application> Bookmark Editor
|
---|
[4c24eb0a] | 283 | (<application>NCurses</application>-based)
|
---|
[b51fe6e] | 284 | </para>
|
---|
[ef3ec45] | 285 | <indexterm zone="ncftp ncftpbookmarks">
|
---|
| 286 | <primary sortas="b-ncftpbookmarks">ncftpbookmarks</primary>
|
---|
| 287 | </indexterm>
|
---|
| 288 | </listitem>
|
---|
| 289 | </varlistentry>
|
---|
[bab92281] | 290 |
|
---|
[ef3ec45] | 291 | <varlistentry id="ncftpget">
|
---|
| 292 | <term><command>ncftpget</command></term>
|
---|
| 293 | <listitem>
|
---|
[b51fe6e] | 294 | <para>
|
---|
| 295 | is an internet file transfer program for scripts used to
|
---|
[4c24eb0a] | 296 | retrieve files
|
---|
[b51fe6e] | 297 | </para>
|
---|
[ef3ec45] | 298 | <indexterm zone="ncftp ncftpget">
|
---|
| 299 | <primary sortas="b-ncftpget">ncftpget</primary>
|
---|
| 300 | </indexterm>
|
---|
| 301 | </listitem>
|
---|
| 302 | </varlistentry>
|
---|
[bab92281] | 303 |
|
---|
[ef3ec45] | 304 | <varlistentry id="ncftpls">
|
---|
| 305 | <term><command>ncftpls</command></term>
|
---|
| 306 | <listitem>
|
---|
[b51fe6e] | 307 | <para>
|
---|
| 308 | is an internet file transfer program for scripts used to
|
---|
[4c24eb0a] | 309 | list files
|
---|
[b51fe6e] | 310 | </para>
|
---|
[ef3ec45] | 311 | <indexterm zone="ncftp ncftpls">
|
---|
| 312 | <primary sortas="b-ncftpls">ncftpls</primary>
|
---|
| 313 | </indexterm>
|
---|
| 314 | </listitem>
|
---|
| 315 | </varlistentry>
|
---|
[bab92281] | 316 |
|
---|
[ef3ec45] | 317 | <varlistentry id="ncftpput">
|
---|
| 318 | <term><command>ncftpput</command></term>
|
---|
| 319 | <listitem>
|
---|
[b51fe6e] | 320 | <para>
|
---|
| 321 | is an internet file transfer program for scripts used to
|
---|
[4c24eb0a] | 322 | transfer files
|
---|
[b51fe6e] | 323 | </para>
|
---|
[ef3ec45] | 324 | <indexterm zone="ncftp ncftpput">
|
---|
| 325 | <primary sortas="b-ncftpput">ncftpput</primary>
|
---|
| 326 | </indexterm>
|
---|
| 327 | </listitem>
|
---|
| 328 | </varlistentry>
|
---|
[bab92281] | 329 |
|
---|
[ef3ec45] | 330 | <varlistentry id="ncftpspooler">
|
---|
| 331 | <term><command>ncftpspooler</command></term>
|
---|
| 332 | <listitem>
|
---|
[b51fe6e] | 333 | <para>
|
---|
[4c24eb0a] | 334 | is a global batch FTP job processor daemon
|
---|
[b51fe6e] | 335 | </para>
|
---|
[ef3ec45] | 336 | <indexterm zone="ncftp ncftpspooler">
|
---|
| 337 | <primary sortas="b-ncftpspooler">ncftpspooler</primary>
|
---|
| 338 | </indexterm>
|
---|
| 339 | </listitem>
|
---|
| 340 | </varlistentry>
|
---|
[bab92281] | 341 |
|
---|
[ef3ec45] | 342 | </variablelist>
|
---|
[bab92281] | 343 |
|
---|
[ef3ec45] | 344 | </sect2>
|
---|
[bab92281] | 345 |
|
---|
[f45b1953] | 346 | </sect1>
|
---|