Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add manpage #16

Closed
wants to merge 1 commit into from
Closed

Conversation

The-King-of-Toasters
Copy link

I showed this off in your last twitch stream, so I might as well make a pull request to make it official. I also remove the reference to gpg(1) ;).

Some questions:

  • The manual does not currently contain any copyright preamble. Should I assign copyright to Google like the source files?
  • I have omitted the -aliases flag as it's not described in the spec. My understanding is that age -aliases filippo prints the key for filippo and age -aliases filippo key modifies the key for filippo.
  • I haven't documented the keys.txt file as I'm unsure of its contents. Will it only contain age keys generated with -G, or other key types?

As for the options, I have my own private fork that uses -G for key generation, -D for decryption and -A for alias stuff. I prefer this as it retains the classic UNIX argument style, which the same style used by signify/minisign. But if you're firm on the existing flags then I don't really mind.

docs/age.1 Show resolved Hide resolved
docs/age.1 Show resolved Hide resolved
docs/age.1 Show resolved Hide resolved
will look for
.Pa "~/Library/Application Support/age/aliases.txt" .
.Sh EXIT STATUS
.Ex -std
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably be expanded upon since it's not at all clear what "failure" will actually be. In particular, it would be helpful if the exit status differentiated between decryption failure due to a MAC mismatch and everything else (out of memory, etc.) and what to do in those crypto failure cases. Though this would need adjusting in the code.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, but I can only work with what I have ;). Let's cross that bridge when we get to it.

@The-King-of-Toasters
Copy link
Author

This pr is seriously out of date, I'll whip up something new and rebase soon.

Also @FiloSottile pls stream on twitch again :(.

@xorhash xorhash mentioned this pull request Jun 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants