Skip to content

Commit

Permalink
Documentation update.
Browse files Browse the repository at this point in the history
  • Loading branch information
roddhjav committed Jun 29, 2019
1 parent 77577f4 commit 4eb3d9f
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 22 deletions.
64 changes: 48 additions & 16 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,71 @@
# Changes By Release
# Changelog

All the releases are signed using the GPG key
[`06A26D531D56C42D66805049C5469996F0DF68EC`](https://pujol.io/keys/)
All notable changes to this project will be documented in this file.

## 1.1 - 2017-12-10
The format is based on [Keep a Changelog][keep-changelog].

* Add --force option, force operation (i.e. even if swap is active) #13.
## [1.2] - 2019-06-29
### Added
* Ensure the GPG keys used are trusted before tomb creation.
* Add a systemd pass-close service unit, allowing more than one timer. [#24](https://github.com/roddhjav/pass-tomb/issues/24)
* Add completion for bash and zsh.

## 1.0 - 2017-05-20
### Changed
* Compatibility with Tomb 2.6
* Simplify test setup

**This is the first stable release.**
### Fixed
* Do not set password tomb permission, only ownership. [#23](https://github.com/roddhjav/pass-tomb/issues/23)
* Use relative path for systemd-run [#18](https://github.com/roddhjav/pass-tomb/pull/18)
* The systemd based timer now works properly

**New features**

## [1.1] - 2017-12-10
### Added
* Add --force option, force operation (i.e. even if swap is active) [#13](https://github.com/roddhjav/pass-tomb/issues/13).


## [1.0] - 2017-05-20
### Added
* This is the first stable release.
* New `-t` option automatically close the password store using a systemd timer.
* New `-p` option to create & open the password tomb in a subfolder of the password store.
* New `-n` option to create a password tomb but do not initialise the password store.
* Added code coverage using [kcov](https://github.com/SimonKagstrom/kcov).

**Code Quality**
### Changed
* The test suite has been changed from an handmade one to the [sharness](https://github.com/chriscool/sharness) test suite.
* Added code coverage using [kcov](https://github.com/SimonKagstrom/kcov).
* The new test suite and code coverage are at the origin of a lot of debugging.

## 0.5 - 2017-04-14

## [0.5] - 2017-04-14
### Added
* Added `--no-init` or `-n` option. With this option, pass-tomb create a tomb but do not initialise the password store.
* Added a quiet mode using `-q`

### Fixed
* Various spelling corrections and code improvement.
* **Warning**: `pass-tomb 0.5` still requires `tomb` to be installed from the master branch:

## 0.2 - 2017-02-28

* Add support for password tomb named with extension. See #2
* Update the way to set ownership when mounting a tomb. See #1
## [0.2] - 2017-02-28
### Added
* Support for password tomb named with extension. [#2](https://github.com/roddhjav/pass-tomb/issues/2)
* Support for the last version of tomb option using GPG key.

## 0.1 - 2017-02-21
### Changed
* Update the way to set ownership when mounting a tomb. [#1](https://github.com/roddhjav/pass-tomb/issues/1)


## [0.1] - 2017-02-21

* Initial release


[1.2]: https://github.com/roddhjav/pass-tomb/releases/tag/v1.2
[1.1]: https://github.com/roddhjav/pass-tomb/releases/tag/v1.1
[1.0]: https://github.com/roddhjav/pass-tomb/releases/tag/v1.0
[0.5]: https://github.com/roddhjav/pass-tomb/releases/tag/v0.5
[0.2]: https://github.com/roddhjav/pass-tomb/releases/tag/v0.2
[0.1]: https://github.com/roddhjav/pass-tomb/releases/tag/v0.1

[keep-changelog]: https://keepachangelog.com/en/1.0.0/
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h1 align="center">Contribution</h1>
# Contribution

You want to contribute to `pass tomb`, **thank a lot for this.** You will find
in this page all the useful information needed to contribute.
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,10 @@ tomb advanced feature like *steganography* and *private cloud storage*. The
[tomb website][tomb] provide a good presentation of the features available with
Tomb. Moreover, you can read my guide on how to use [Tomb with GPG keys][pujol.io-tomb].

pass-tomb is not compatible with Android, but it should not be an issue for you.
If you consider it is safe to put your password-store on Android then, it
probably mean you attacker model does not require the need of pass-tomb.

## Installation

**Requirements**
Expand Down Expand Up @@ -233,7 +237,7 @@ Feedback, contributors, pull requests are all very welcome.

## License

Copyright (C) 2017 Alexandre PUJOL
Copyright (C) 2017-2019 Alexandre PUJOL

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down
10 changes: 6 additions & 4 deletions pass-tomb.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH pass-tomb 1 "May 2017" "pass-tomb"
.TH pass-tomb 1 "June 2019" "pass-tomb"

.SH NAME
pass-tomb \- A \fBpass\fP(1) extension that helps to keep the whole tree of
Expand Down Expand Up @@ -71,9 +71,10 @@ are doing if you force an operation.
Open a password tomb. If a .timer file is present in the store, a systemd timer
will be initialized.

If \fI--timer\fP, \fI-t\fP is specified, along with an
argument, the password store will be automatically closed using a systemd timer
after a given time. If a .time file was already present in the store, this time will be updated.
If \fI--timer\fP, \fI-t\fP is specified, along with an argument, the password
store will be automatically closed using a systemd timer after a given time.
If a '.time' file was already present in the store, this time will be updated.
Multiple timer can be used in the same time.

If \fI--force\fP is specified, the password store will create or mount the
password store even if a plain text swap is present. Make sure you know what you
Expand Down Expand Up @@ -220,6 +221,7 @@ Password tomb size in MB, by default \fI10\fP
.BR tomb(1),
.BR pass-import(1),
.BR pass-update(1),
.BR pass-audit(1),
.BR pass-otp(1)


Expand Down

0 comments on commit 4eb3d9f

Please sign in to comment.