void-linux / void-linux/void-runit

Void lacks a man page for the crypttab file

Open
#39 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
245
Forks
67
Avg merge
2d
Merged PRs (30d)
2

Description

As I mentioned here https://github.com/void-linux/void-packages/issues/20452, no package has man pages for how to set up the crypttab file. @daniel-eys has pointed me in this direction, so I can try to write one based on the crypt.awk script, trying to follow the style of the crypttab man pages offered by both systemd and DragonFlyBSD.

If you have any suggestions for this, please let me know.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the crypt.awk script to understand the crypttab behavior, then compare the crypttab man pages provided by systemd and DragonFlyBSD. Add a Void man page that documents the supported crypttab setup and matches the project's documentation style; done means the file accurately reflects crypt.awk and is included in the repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
awk
Domain
documentation, operating-systems
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.