Index of /ctfs/

CENTAUR TERMINAL FILE SERVER ---------------------------- Version 1.0 1/8/2021 http://www.centaur.pw <jon@centel.cc> ABOUT ----- Serve non-binary files through a terminal interface, to be downloaded and viewed using Centaur Terminal File Client (CTFC) COMPILING & INSTALLATION ------------------------ By default, a new directory, '/srv/ctfs' is created (recursively if necessary when installing. The 'INSTALLDIR' variable in the Makefile can be changed as desired. Note that CTFS requires its own directory, and this directory will also be the base directory for the file server. To build the 'ctfs' binary: $ make To move the 'ctfs' binary to /srv/ctfs and copy the manual page file 'ctfs.7.gz' to /usr/share/man/man7: $ make install To remove the object files generated by make: $ make clean To delete the installed binary and manual: $ make uninstall COMMAND LINE PARAMETERS ----------------------- Syntax: ctfs [-H] [port] & [-H] - Display program syntax and options [port] must be a valid TCP port number. If not specified, port number defaults to 4444. It is recommended that CTFS be executed in the background with '&', as it does not output to the screen or log activity. The socket connection is made at the time a client sends a request and closed immediately after it is fulfilled. Only one file at a time can be requested. If a connection is made with a client other than CTFC, files can usually be read, but generally not downloaded. A file should not be greater than 100 MB, as this is the maximum transfer buffer size. MANIFEST FILE ------------- A file named 'MANIFEST' must be placed in the server directory, i.e. the same directory CTFS was installed to. This file contains a list of files available for download. Files that do not appear on the list cannot be downloaded, even if they are in the server directory. The CTFS server will fail to start if the file 'MANIFEST' is missing from its working directory. The format and structure of the manifest file is very simple. Each file is listed on its own line, and any remarks may placed after a space between the file name. Text after the file name, blank lines, and lines beginning with '#' are ignored when querying the manifest. Entries can be relative or absolute paths to files. MANIFEST can be easily created by piping 'ls' output to a file, or written manually. The manifest, or the files listed in it, may be modified at any time without restarting the server. Example File ------------ MANIFEST for site.zzz (Program) program.c <- Main program code program.h <- Main program header file # Documentation ./docs/INSTALL <- Installation instructions ./docs/README <- General program documentation /srv/ctfs/general/Help.txt <- General help In the above example, the server ignores anything after a space on a given line, allowing warnings, notes, etc. to be shown when the client views or downloads the manifest. The comment in the middle is visible when viewing the manifest, but will not interfere with download requests. The file 'MANIFEST' should be included in the manifest, or it will not be readable to the client. However, other files listed will still be available. To simplify matters for the client, files should be in the same directory as the server, as the client must request files exactly as they appear in the manifest. In any case, the client may change the output file if the file name or directory structure is not desirable.