From 21d51f7e0a639a3224ffc45dc3c06854decf1d45 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Tue, 30 Jan 2024 20:51:38 +0000 Subject: Initial commit Signed-off-by: Laurent Bercot --- doc/apaste.html | 114 +++++++++++++++++++++++++++++++++++++++++++++ doc/apastec.html | 88 +++++++++++++++++++++++++++++++++++ doc/apasted.html | 137 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/index.html | 110 ++++++++++++++++++++++++++++++++++++++++++++ doc/upgrade.html | 28 ++++++++++++ 5 files changed, 477 insertions(+) create mode 100644 doc/apaste.html create mode 100644 doc/apastec.html create mode 100644 doc/apasted.html create mode 100644 doc/index.html create mode 100644 doc/upgrade.html (limited to 'doc') diff --git a/doc/apaste.html b/doc/apaste.html new file mode 100644 index 0000000..34f66d3 --- /dev/null +++ b/doc/apaste.html @@ -0,0 +1,114 @@ + + + + + + apaste: the apaste program + + + + + + +

+apaste
+Software
+skarnet.org +

+ +

The apaste program

+ +

+ apaste is a program that reads one or more files, or its +standard input, and sends the data to an apasted +server. +

+ +

Interface

+ +
+     apaste [ -S | -s ] [ -C cadir ] [ -d server[:port] ] [ -r rtimeout ] [ -w wtimeout ] file...
+
+ + + +

Exit codes

+ +
+
0
Success. The data has been recorded by the server and available in +some way as indicated by the slug.
+
100
Bad usage. apaste was run in an incorrect way.
+
111
System call failed. This usually signals an issue with the +underlying operating system, or with the network in some way. +
+ +

Options

+ +
+
-S
+
Normal, plain text connection to the server, even if the built-in default +is TLS. The built-in default can be changed via the --with-default-tls +or --without-default-tls options to configure.
+ +
-s
+
TLS connection to the server, even if the built-in default +is plain text. The built-in default can be changed via the --with-default-tls +or --without-default-tls options to configure.
+ +
-C cadir
+
When using a TLS connection, use cadir as the directory +containing the hashed names of the trust anchor certificates +(used for verifying the server's certificate chain). The built-in default +can be changed via the --with-default-cadir option to configure.
+ +
-d server[:port]
+
Connect to server server, port port. The built-in defaults +can be changed via the --with-default-server, --with-default-port, +and --with-default-tlsport options to configure.
+ +
-r rtimeout
+
If the server isn't answering with a slug within rtimeout +milliseconds, give up. The default is 0, meaning infinite: apaste will +wait forever for a server reply if necessary.
+ +
-w wtimeout
+
If the server hasn't accepted all the data within wtimeout +milliseconds, give up. The default is 0, meaning infinite: apaste will +take as much time as it needs to send its data.
+
+ +

Example usage

+ + + +

Notes

+ + + + + diff --git a/doc/apastec.html b/doc/apastec.html new file mode 100644 index 0000000..6711f3f --- /dev/null +++ b/doc/apastec.html @@ -0,0 +1,88 @@ + + + + + + apaste: the apastec program + + + + + + +

+apaste
+Software
+skarnet.org +

+ +

The apastec program

+ +

+ apastec is a program that reads one or more files, or its +standard input, and sends them to a preopened file descriptor. +

+ +

Interface

+ +
+     apastec [ -r rtimeout ] [ -w wtimeout ] file...
+
+ + + +

Exit codes

+ +
+
0
Success. The data has been recorded by the server and available in +some way as indicated by the slug.
+
100
Bad usage. apaste was run in an incorrect way.
+
111
System call failed. This usually signals an issue with the +underlying operating system, or with the network in some way. +
+ +

Options

+ +
+
-r rtimeout
+
If the server isn't answering with a slug within rtimeout +milliseconds, give up. The default is 0, meaning infinite: apastec will +wait forever for a server reply if necessary.
+ +
-w wtimeout
+
If the server hasn't accepted all the data within wtimeout +milliseconds, give up. The default is 0, meaning infinite: apastec will +take as much time as it needs to send its data.
+
+ +

Typical usage

+ +

+ apastec isn't meant to be used directly. It is meant to be invoked as +part of a command line crafted by the apaste +command, where programs from the +s6-networking package +establish the connection to the server, then exec into apastec to read +the user's data and transmit them with the apaste protocol. +

+ +

Notes

+ + + + + diff --git a/doc/apasted.html b/doc/apasted.html new file mode 100644 index 0000000..98ec51d --- /dev/null +++ b/doc/apasted.html @@ -0,0 +1,137 @@ + + + + + + apaste: the apasted program + + + + + + +

+apaste
+Software
+skarnet.org +

+ +

The apasted program

+ +

+ apasted is the server-side program for the apaste package. It +expects its stdin and stdout to be connected to the network, having being +contacted by an apastec client. It reads a +series of files transmitted by the client, stores it on the server, and +sends back a slug to the client, i.e. an identifier for the +stored files. +

+ +

Interface

+ +
+     apasted [ -r rtimeout ] [ -w wtimeout ] [ -d rootdir ] [ -p prefix ] [ -m maxfiles ]
+
+ + + +

Exit codes

+ +
+
0
Success.
+
1
Protocol error. The client sent incorrectly formatted data.
+
100
Bad usage. apasted was run in an incorrect way.
+
111
System call failed. This usually signals an issue with the +underlying operating system, or with the network in some way. +
+ +

Options

+ +
+
-r rtimeout
+
If the client hasn't transmitted all its data within rtimeout +milliseconds, give up. The default is 0, meaning infinite: apasted will +wait forever for client data if necessary.
+ +
-w wtimeout
+
If apasted fails to send the slug to the client within wtimeout +milliseconds, give up. The default is 0, meaning infinite: apasted will +take as much time as it needs to send its answer.
+ +
-d rootdir
+
Switch to rootdir and store files there. The default is +apasted's working directory.
+ +
-p prefix
+
When sending a slug to the client, prefix subdir with prefix, +and append a slash at the end. This is useful when apasted writes its files to +a web server's document hierarchy, which is the intended case. If prefix +is the URL of apasted's base directory, then the slug can directly be used as a +URL to access the client's files.
+ +
-m maxfiles
+
Accept a maximum of maxfiles files at a time from the client. +The default is 0, meaning unlimited: the client can send as many files as it +wants and apasted will still store them if it is possible.
+
+ +

Typical usage

+ + + +

Caveats

+ + + +

Notes

+ + + + + diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..6697333 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,110 @@ + + + + + + apaste - a small command-line pastebin + + + + + + +

+Software
+skarnet.org +

+ +

apaste

+ +

What is it ?

+ +

+ apaste is a small command-line pastebin, to share terminal output +by pushing it to a server, so it can be made public via the Web or some +other protocol. +

+ +
+ +

Installation

+ +

Requirements

+ + + +

Licensing

+ +

+ apaste is free software. It is available under the +ISC license. +

+ +

Download

+ + + +

Compilation

+ + + +

Upgrade notes

+ + + +
+ +

Reference

+ +

Commands

+ + + +

Related resources

+ + + +

Similar work

+ + + + + diff --git a/doc/upgrade.html b/doc/upgrade.html new file mode 100644 index 0000000..c8650e5 --- /dev/null +++ b/doc/upgrade.html @@ -0,0 +1,28 @@ + + + + + + apaste: how to upgrade + + + + + + +

+apaste
+Software
+skarnet.org +

+ +

What has changed in apaste

+ +

in 0.0.1.0

+ + + + + -- cgit v1.3.1