updating documentation
This commit is contained in:
parent
f247b1d566
commit
ec4faf0ae6
25
README.md
25
README.md
@ -63,12 +63,19 @@ set.
|
|||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
|
|
||||||
|
### Server
|
||||||
|
|
||||||
To run a server, just run:
|
To run a server, just run:
|
||||||
|
|
||||||
netgiv --server
|
netgiv --server
|
||||||
|
|
||||||
`netgiv` will run in the foreground and log accesses to it.
|
`netgiv` will run in the foreground and log accesses to it.
|
||||||
|
|
||||||
|
### Client
|
||||||
|
|
||||||
|
#### Copy
|
||||||
|
|
||||||
On any client, run:
|
On any client, run:
|
||||||
|
|
||||||
$ echo "Hello" | netgiv
|
$ echo "Hello" | netgiv
|
||||||
@ -79,6 +86,8 @@ To check for success, try:
|
|||||||
|
|
||||||
You should see "hello" echoed on your terminal.
|
You should see "hello" echoed on your terminal.
|
||||||
|
|
||||||
|
#### List
|
||||||
|
|
||||||
To check the list of files on the server:
|
To check the list of files on the server:
|
||||||
|
|
||||||
$ netgiv -l
|
$ netgiv -l
|
||||||
@ -89,6 +98,8 @@ To check the list of files on the server:
|
|||||||
|
|
||||||
Note that netgiv tries to identify each file based on file magic heuristics.
|
Note that netgiv tries to identify each file based on file magic heuristics.
|
||||||
|
|
||||||
|
#### Paste
|
||||||
|
|
||||||
If you would like to fetch (paste) a particular file:
|
If you would like to fetch (paste) a particular file:
|
||||||
|
|
||||||
netgiv -p 3 > file.mov
|
netgiv -p 3 > file.mov
|
||||||
@ -98,6 +109,14 @@ Where '3' comes from the information provided in the `-l` output.
|
|||||||
Note that providing no `-p` option is the same as `-p X` where X is the highest
|
Note that providing no `-p` option is the same as `-p X` where X is the highest
|
||||||
numbered upload (most recent).
|
numbered upload (most recent).
|
||||||
|
|
||||||
|
#### Burn
|
||||||
|
|
||||||
|
If you would like to remove/delete (burn) a particular file:
|
||||||
|
|
||||||
|
netgiv -b 3
|
||||||
|
|
||||||
|
Where '3' comes from the information provided in the `-l` output.
|
||||||
|
|
||||||
### Notes on output
|
### Notes on output
|
||||||
|
|
||||||
Since netgiv is designed to be used in a pipeline, it does not provide any
|
Since netgiv is designed to be used in a pipeline, it does not provide any
|
||||||
@ -129,8 +148,10 @@ to the client - the server must have a config file with an authtoken specified.
|
|||||||
|
|
||||||
## Temporary file storage
|
## Temporary file storage
|
||||||
|
|
||||||
The `netgiv` server will store files in your normal system temporary dir. They will
|
The `netgiv` server will store files in your normal system temporary dir. These files
|
||||||
be deleted when the server shuts down (SIGTERM). These files are *not* encrypted.
|
are *not* encrypted. They will be deleted when the server shuts down (SIGTERM). If you
|
||||||
|
want or need to remove the files before the server shuts down, you can use the
|
||||||
|
[burn](#burn) flag.
|
||||||
|
|
||||||
## Window support
|
## Window support
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user