Add tag documentation to man page.

Open Beginner friendly
#564 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Domain
cli, documentation

Research direction

Start with the Timeshift man page and review the tag descriptions referenced in issue #168. Add explanations for the O, B, H, D, W, and M tag letters alongside the --tags option; done means CLI users can understand these values without consulting the README.

Written by the indexing model from the issue text.

Description

Please update the man page to include the tag descriptions in #168 (partially fixes #77 ). There's no reason to expect that someone trying to use the CLI will necessarily have access to https://github.com/linuxmint/timeshift/blob/master/README.md so when looking at the man page, there's no elucidation of what these letters mean:

TIMESHIFT(1)                                        User Commands                                       TIMESHIFT(1)

NAME
     Timeshift - manual page for Timeshift 25.12.4

DESCRIPTION
     Timeshift v25.12.4 by Tony George (teejeetech@gmail.com)
⋮
     --tags {O,B,H,D,W,M}
            Add tags to snapshot (default: O)

Thanks!

Dominant language
Vala
Stars
4.3k
Forks
155
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from linuxmint/timeshift

All issues in linuxmint/timeshift

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.