Skip to content

Commit be80cf2

Browse files
authored
fix(docs): removing reference to invalid 'gopass binary' command, and adding docs for 'fsmove' and 'fscopy' (gopasspw#3321)
Signed-off-by: Yolan Romailler <AnomalRoil@users.noreply.github.com>
1 parent 736bf10 commit be80cf2

3 files changed

Lines changed: 71 additions & 2 deletions

File tree

‎docs/commands/fscopy.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# `fscopy` command
2+
3+
The `fscopy` command is used to copy a file from your filesystem into your
4+
password store, while keeping it in clear in your local filesystem after
5+
having stored it in your encrypted store.
6+
7+
## Synopsis
8+
9+
```bash
10+
$ gopass fscopy ~/test/file data/test/file-entry
11+
$ gopass fscopy data/test/file-entry ~/file
12+
```
13+
14+
## Modes of operation
15+
16+
This command either reads a file from the filesystem and writes the
17+
encoded and encrypted version in the store or it decrypts and decodes
18+
a secret and writes the result to a file. Either source or destination
19+
must be a file and the other one a secret.
20+
If you want the source to be removed use 'gopass fsmove'.
21+
22+
`fscopy` is intended to work with raw files.
23+
24+
### Example
25+
```
26+
$ gopass fscopy ~/test/file data/test/file-entry
27+
$ gopass cat data/test/file-entry
28+
```
29+
30+
See also the docs for the [`cat` action](cat.md).
31+
32+
## Flags
33+
34+
This command has currently no supported flags except the gopass globals.

‎docs/commands/fsmove.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# `fsmove` command
2+
3+
The `fsmove` command is used to move a file from your filesystem into your
4+
password store, erasing it from your local filesystem after having stored it in your encrypted store.
5+
6+
## Synopsis
7+
8+
```bash
9+
$ gopass fsmove ~/test/file data/test/file-entry
10+
$ gopass fsmove data/test/file-entry ~/file
11+
```
12+
13+
## Modes of operation
14+
15+
This command either reads a file from the filesystem and writes the
16+
encoded and encrypted version in the store or it decrypts and decodes
17+
a secret and writes the result to a file. Either source or destination
18+
must be a file and the other one a secret. The source will be wiped
19+
from disk or from the store after it has been copied successfully
20+
and validated. If you don't want the source to be removed use
21+
'gopass fscopy'.
22+
23+
`fsmove` is intended to work with raw files.
24+
25+
### Example
26+
```
27+
$ gopass fsmove ~/test/file data/test/file-entry
28+
$ gopass cat data/test/file-entry
29+
```
30+
31+
See also the docs for the [`cat` action](cat.md).
32+
33+
## Flags
34+
35+
This command has currently no supported flags except the gopass globals.

‎internal/action/commands.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ func (s *Action) GetCommands() []*cli.Command {
403403
"encoded and encrypted version in the store or it decrypts and decodes " +
404404
"a secret and writes the result to a file. Either source or destination " +
405405
"must be a file and the other one a secret. If you want the source to " +
406-
"be securely removed after copying, use 'gopass binary move'",
406+
"be securely removed after copying, use 'gopass fsmove'",
407407
Before: s.IsInitialized,
408408
Action: s.BinaryCopy,
409409
BashComplete: s.Complete,
@@ -419,7 +419,7 @@ func (s *Action) GetCommands() []*cli.Command {
419419
"must be a file and the other one a secret. The source will be wiped " +
420420
"from disk or from the store after it has been copied successfully " +
421421
"and validated. If you don't want the source to be removed use " +
422-
"'gopass binary copy'",
422+
"'gopass fscopy'",
423423
Before: s.IsInitialized,
424424
Action: s.BinaryMove,
425425
BashComplete: s.Complete,

0 commit comments

Comments
 (0)
⌂ 换网址