network/tnfs-fuse: Fix man page, CLI client.

Signed-off-by: B. Watson <urchlay@slackware.uk>

Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>
This commit is contained in:
B. Watson 2022-08-24 12:26:01 -04:00 committed by Willy Sudiarto Raharjo
parent 7de070015b
commit 178521a103
No known key found for this signature in database
GPG Key ID: 3F617144D7238786
5 changed files with 223 additions and 26 deletions

View File

@ -0,0 +1,108 @@
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "TNFS-CLIENT" 1 "2022-08-24" "20130127_fd46ff" "SlackBuilds.org"
.SH NAME
tnfs-client \- trivial network filesystem client
.\" RST source for tnfs-client(1) man page. Convert with:
.
.\" rst2man.py tnfs-client.rst > tnfs-client.1
.
.\" rst2man.py comes from the SBo development/docutils package.
.
.SH SYNOPSIS
.sp
\fBtnfs\-client\fP [\fIhost\fP [\fIport\fP]]
.SH DESCRIPTION
.sp
TNFS is a simplified Internet file transfer protocol, designed for
simplicity and ease of implementation on small systems, such as 8\-bit
computers. It\(aqs simpler than NFS, SMB, or FTP. It\(aqs similar to TFTP,
but has features TFTP lacks.
.sp
\fBtnfs\-client\fP is a simple client for the TNFS protocol. It uses UDP
port 16384 by default (standard for TNFS).
.sp
\fBtnfs\-client\fP doesn\(aqt mount the TNFS share as a directory (see
\fBtnfs\-fuse\fP(1) for that). It has a textmode user interface similar
to \fBftp\fP(1).
.sp
If \fBhost\fP is omitted, the default host is \fIvexed4.alioth.net\fP\&. If
\fBport\fP is omitted, the default port is \fI16384\fP\&.
.SH COMMANDS
.sp
The client supports these commands:
.INDENT 0.0
.TP
.B \fBls\fP [\fI\-l\fP]
List contents of current directory. With \fI\-l\fP, show details.
.TP
.B \fBdir\fP [\fI\-l\fP]
Synonym for \fBls\fP\&.
.TP
.B \fBcd\fP \fIpath\fP
Change working directory on server to \fIpath\fP\&.
.TP
.B \fBpwd\fP
Print current working directory on server.
.TP
.B \fBget\fP \fIremote\-filename\fP [\fIlocal\-filename\fP]
Download a file.
.TP
.B \fBput\fP \fIlocal\-filename\fP [\fIremote\-filename\fP]
Upload a file.
.TP
.B \fBmkdir\fP \fIpath\fP
Create a directory.
.TP
.B \fBrmdir\fP \fIpath\fP
Delete a directory (which must be empty).
.TP
.B \fBquit\fP
Exit the client.
.UNINDENT
.sp
Note that there\(aqs no \fBrm\fP command, or any other way to delete
a file. There\(aqs also no \fBlcd\fP command; you can\(aqt change the local
working directory, so make sure you\(aqre in the right place before you
start the client.
.SH COPYRIGHT
.sp
See the file /usr/doc/tnfs\-fuse\-20130127_fd46ff/COPYING for license information.
.SH AUTHORS
.sp
tnfs\-client was written by Radu Cristescu.
.sp
This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.
.SH SEE ALSO
.sp
\fBtnfs\-fuse\fP(1), \fBtnfsd\fP(1), \fBfuse\fP(8)
.\" Generated by docutils manpage writer.
.

View File

@ -0,0 +1,97 @@
.. RST source for tnfs-client(1) man page. Convert with:
.. rst2man.py tnfs-client.rst > tnfs-client.1
.. rst2man.py comes from the SBo development/docutils package.
.. |version| replace:: 20130127_fd46ff
.. |date| date::
===========
tnfs-client
===========
---------------------------------
trivial network filesystem client
---------------------------------
:Manual section: 1
:Manual group: SlackBuilds.org
:Date: |date|
:Version: |version|
SYNOPSIS
========
**tnfs-client** [*host* [*port*]]
DESCRIPTION
===========
TNFS is a simplified Internet file transfer protocol, designed for
simplicity and ease of implementation on small systems, such as 8-bit
computers. It's simpler than NFS, SMB, or FTP. It's similar to TFTP,
but has features TFTP lacks.
**tnfs-client** is a simple client for the TNFS protocol. It uses UDP
port 16384 by default (standard for TNFS).
**tnfs-client** doesn't mount the TNFS share as a directory (see
**tnfs-fuse**\(1) for that). It has a textmode user interface similar
to **ftp**\(1).
If **host** is omitted, the default host is *vexed4.alioth.net*. If
**port** is omitted, the default port is *16384*.
COMMANDS
========
The client supports these commands:
**ls** [*-l*]
List contents of current directory. With *-l*, show details.
**dir** [*-l*]
Synonym for **ls**.
**cd** *path*
Change working directory on server to *path*.
**pwd**
Print current working directory on server.
**get** *remote-filename* [*local-filename*]
Download a file.
**put** *local-filename* [*remote-filename*]
Upload a file.
**mkdir** *path*
Create a directory.
**rmdir** *path*
Delete a directory (which must be empty).
**quit**
Exit the client.
Note that there's no **rm** command, or any other way to delete
a file. There's also no **lcd** command; you can't change the local
working directory, so make sure you're in the right place before you
start the client.
COPYRIGHT
=========
See the file /usr/doc/tnfs-fuse-|version|/COPYING for license information.
AUTHORS
=======
tnfs-client was written by Radu Cristescu.
This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.
SEE ALSO
========
**tnfs-fuse**\(1), **tnfsd**\(1), **fuse**\(8)

View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "TNFS-FUSE" 1 "2022-07-24" "20130127_fd46ff" "SlackBuilds.org"
.TH "TNFS-FUSE" 1 "2022-08-24" "20130127_fd46ff" "SlackBuilds.org"
.SH NAME
tnfs-fuse \- trivial network filesystem client
.\" RST source for tnfs-fuse(1) man page. Convert with:
@ -46,16 +46,8 @@ simplicity and ease of implementation on small systems, such as 8\-bit
computers. It\(aqs simpler than NFS, SMB, or FTP. It\(aqs similar to TFTP,
but has features TFTP lacks.
.sp
\fBtnfs\-fuse\fP is a client for the TNFS protocol.
.sp
Note that \fBtnfs\-fuse\fP uses TCP to communicate with the TNFS server.
Most TNFS clients are written for smaller systems (e.g. Atari or
Spectrum 8\-bit computers) and use UDP. This isn\(aqt an actual problem,
but it\(aqs a factor to take into account when e.g. setting up firewall
rules to allow TNFS traffic. Also, when troubleshooting a failed
TNFS connection from an 8\-bit client, just because you can connect
with \fBtnfs\-fuse\fP using TCP, doesn\(aqt mean the UDP port is open and
working.
\fBtnfs\-fuse\fP is a client for the TNFS protocol. It uses UDP port
16384 by default (standard for TNFS).
.sp
When working with mounted TNFS directories, some error messages will
be wrong, e.g. instead of "Permission denied", you may get "Bad file
@ -102,6 +94,6 @@ This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.
.SH SEE ALSO
.sp
\fBtnfsd\fP(1), \fBfuse\fP(8)
\fBtnfs\-client\fP(1), \fBtnfsd\fP(1), \fBfuse\fP(8)
.\" Generated by docutils manpage writer.
.

View File

@ -6,11 +6,17 @@
# Licensed under the WTFPL. See http://www.wtfpl.net/txt/copying/ for details.
# 20220824 bkw: BUILD=2
# - fix man page: this client does *not* use TCP, I don't know what
# I was smoking when I wrote that...
# - tnfs_client.py, the library, is also an executable. include
# symlink to /usr/bin and man page for it.
cd $(dirname $0) ; CWD=$(pwd)
PRGNAM=tnfs-fuse
VERSION=${VERSION:-20130127_fd46ff}
BUILD=${BUILD:-1}
BUILD=${BUILD:-2}
TAG=${TAG:-_SBo}
PKGTYPE=${PKGTYPE:-tgz}
@ -88,7 +94,8 @@ patch -p1 < $CWD/libdir.diff
mkdir -p $PKG/usr/bin
sed "s,@LIBDIR@,$LIBDIR," < $PRGNAM.py > $PKG/usr/bin/$PRGNAM
chmod 755 $PKG/usr/bin/$PRGNAM
cp -a tnfs_client.py $PKGLIB
install -m0755 tnfs_client.py $PKGLIB
ln -s ../lib$LIBDIRSUFFIX/$PRGNAM/tnfs_client.py $PKG/usr/bin/tnfs-client
PKGDOC=$PKG/usr/doc/$PRGNAM-$VERSION
mkdir -p $PKGDOC
@ -98,9 +105,10 @@ cat $CWD/$PRGNAM.SlackBuild > $PKGDOC/$PRGNAM.SlackBuild
# upstream didn't include a separate license, so copy/paste the comments.
cat $CWD/COPYING > $PKGDOC/COPYING
# man page written for this SlackBuild.
# man pages written for this SlackBuild.
mkdir -p $PKG/usr/man/man1
gzip -9c < $CWD/$PRGNAM.1 > $PKG/usr/man/man1/$PRGNAM.1.gz
gzip -9c < $CWD/tnfs-client.1 > $PKG/usr/man/man1/tnfs-client.1.gz
mkdir -p $PKG/install
cat $CWD/slack-desc > $PKG/install/slack-desc

View File

@ -31,16 +31,8 @@ simplicity and ease of implementation on small systems, such as 8-bit
computers. It's simpler than NFS, SMB, or FTP. It's similar to TFTP,
but has features TFTP lacks.
**tnfs-fuse** is a client for the TNFS protocol.
Note that **tnfs-fuse** uses TCP to communicate with the TNFS server.
Most TNFS clients are written for smaller systems (e.g. Atari or
Spectrum 8-bit computers) and use UDP. This isn't an actual problem,
but it's a factor to take into account when e.g. setting up firewall
rules to allow TNFS traffic. Also, when troubleshooting a failed
TNFS connection from an 8-bit client, just because you can connect
with **tnfs-fuse** using TCP, doesn't mean the UDP port is open and
working.
**tnfs-fuse** is a client for the TNFS protocol. It uses UDP port
16384 by default (standard for TNFS).
When working with mounted TNFS directories, some error messages will
be wrong, e.g. instead of "Permission denied", you may get "Bad file
@ -87,4 +79,4 @@ by B. Watson, and is licensed under the WTFPL.
SEE ALSO
========
**tnfsd**\(1), **fuse**\(8)
**tnfs-client**\(1), **tnfsd**\(1), **fuse**\(8)