Compare commits

...

4 commits

Author SHA1 Message Date
Russtopia
f24d4d8fdb Update 'README.md' 2022-07-02 12:51:18 -07:00
Russtopia
42ad33065b Update 'README.md' 2022-07-02 12:44:37 -07:00
Russtopia
41769660cc Bump version → 0.9.5.1 2022-07-02 12:01:15 -07:00
Russtopia
73eadf7534 Update 'README.md' 2022-07-02 12:00:12 -07:00
2 changed files with 22 additions and 10 deletions

View file

@ -1,4 +1,4 @@
VERSION := 0.9.4 VERSION := 0.9.5.1
.PHONY: lint vis clean common client server passwd subpkgs install uninstall reinstall .PHONY: lint vis clean common client server passwd subpkgs install uninstall reinstall
## Tag version of binaries with build info wrt. ## Tag version of binaries with build info wrt.

View file

@ -102,23 +102,34 @@ As of this time (Oct 2018) Kyber is one of the candidate algorithms submitted to
* [blitter.com/go/mtwist](https://gogs.blitter.com/RLabs/mtwist) // 64-bit Mersenne Twister PRNG * [blitter.com/go/mtwist](https://gogs.blitter.com/RLabs/mtwist) // 64-bit Mersenne Twister PRNG
* [blitter.com/go/cryptmt](https://gogs.blitter.com/RLabs/cryptmt) // CryptMTv1 stream cipher * [blitter.com/go/cryptmt](https://gogs.blitter.com/RLabs/cryptmt) // CryptMTv1 stream cipher
### Installing
As of Go 1.8, one can directly use `go install` to get the client `xs` and server `xsd` binaries; however it is not recommended, as `xsd` requires root and for general use should be in one of the system directories, akin to other daemons. If one insists, the following will work to place them in $HOME/go/bin:
```
$ go install blitter.com/go/xs/xs@latest
$ go install blitter.com/go/xs/xsd@latest
```
(NOTE the `-v` (version) option for binaries obtained in this manner will be blank; another reason to build them yourself locally using the steps below.)
### Get source code ### Get source code
``` ```
$ go get -u blitter.com/go/xs $ git clone https://gogs.blitter.com/RLabs/xs
$ cd $GOPATH/src/blitter.com/go/xs
$ go build ./... # install all dependent go pkgs
``` ```
### To build ### To build
``` ```
$ cd $GOPATH/src/blitter.com/go/xs $ cd xs
$ make clean all $ make clean && make
``` ```
### To install, uninstall, re-install ### To install, uninstall, re-install (xsd server)
``` ```
$ sudo make [install | uninstall | reinstall] $ sudo make [install | uninstall | reinstall]
@ -146,9 +157,10 @@ The make system assumes installation in /usr/local/sbin (xsd, xspasswd) and /usr
``` ```
$ sudo rc-config [start | restart | stop] xsd $ sudo rc-config [start | restart | stop] xsd
# .. or sudo /etc/init.d/xsd [start | restart stop]
``` ```
### To set accounts & passwords: ### To set accounts & passwords (DEPRECATED: `-s` is now true by default)
``` ```
$ sudo touch /etc/xs.passwd $ sudo touch /etc/xs.passwd
@ -214,7 +226,7 @@ NOTE: Renaming while copying (eg., 'cp /foo/bar/fileA ./fileB') is NOT supported
If the 'pv' pipeview utility is available (http://www.ivarch.com/programs/pv.shtml) file transfer progress and bandwidth control will be available (suppress the former with the -q option, set the latter with -L <bytes_per_second>). If the 'pv' pipeview utility is available (http://www.ivarch.com/programs/pv.shtml) file transfer progress and bandwidth control will be available (suppress the former with the -q option, set the latter with -L <bytes_per_second>).
Special care should be taken when doing client->server copies: since the tarpipe (should) always succeed at least sending data to the remote side, a destination with no write permission will not return a nonzero status and the client closes its end after sending all data, giving the server no opportunity to send an error code to the client. Special care should be taken when doing clientserver copies: since the tarpipe (should) always succeed at least sending data to the remote side, a destination with no write permission will not return a nonzero status and the client closes its end after sending all data, giving the server no opportunity to send an error code to the client.
It is recommended to test beforehand if the server-side destination is writable (and optionally if the destination already exists, if one does not want to clobber an existing path) by: It is recommended to test beforehand if the server-side destination is writable (and optionally if the destination already exists, if one does not want to clobber an existing path) by:
``` ```
@ -226,7 +238,7 @@ Perhaps in future a more complex handshake will be devised to allow the client t
### Tunnels ### Tunnels
Simple tunnels (client -> server, no reverse tunnels for now) are supported. Simple tunnels (client server, no reverse tunnels for now) are supported.
Syntax: xs -T=<tunspec>{,<tunspec>...} Syntax: xs -T=<tunspec>{,<tunspec>...}
.. where <tunspec> is <localport:remoteport> .. where <tunspec> is <localport:remoteport>