docs(man): complete, accurate rewrite of the man page - #73
Merged
Conversation
Rework docs/man/oans.md (regenerating oans.8 via pandoc) into a full, current reference: - Document every option with defaults and detail, grouped by purpose (operation / scan tuning / threads / reporting / output). Add the missing --version; describe --autotune, --stats/--history/--json, --dedupe-options tokens, thread auto-tuning, and -h correctly. - New OUTPUT section explaining the summary: Reclaimed is the honest disk-freed figure (one copy kept per group), the machine "net change in shared extents" line is a fiemap diagnostic (~2x for pairs), and the compression caveat (use compsize Disk Usage). This replaces the stale "shared bytes before/after" estimate wording. - Rich EXAMPLES (incremental hashfile, bare replay, exclude+min-filesize, stats/history/json, autotune, systemd scheduling) plus EXIT STATUS, ENVIRONMENT, FILES, and refreshed NOTES/FAQ. - completion/zsh/_oans: add the missing --autotune. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- SYNOPSIS: drop [-r] from the --autotune form; OPTIONS states --autotune always samples recursively, so advertising -r there contradicted it. - MODES: defer the read-only-concurrency-safety claim to NOTES instead of stating it in both places. Regenerated oans.8 (pandoc 3.7). Accuracy/completion/artifact reviews were clean; other prose overlaps kept as man-page-conventional. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A ground-up rewrite of
docs/man/oans.md(withoans.8regenerated via pandoc, now installed on the box), bringing the reference up to the quality of the tool.Why
The old page was duperemove's, with fork features bolted on. It was stale — it still described the reclaimed figure as "comparing shared bytes before and after the dedupe" (removed in the honest-accounting change) — and it was missing
--versionentirely.What's new
src/opt.cand the parser: blocksize 128K (4K–1M), batchsize 1024, min-filesize 1,dedupe_same_fileon, io-threads auto / cpu-threads nproc≤8, and the[no]same/[no]partial/[no]only_whole_filestokens.Reclaimed(honest disk-freed, one copy kept per group), the machinenet change in shared extentsdiagnostic (~2× for pairs), and the compressed-btrfs caveat (comparecompsizeDisk Usage).--exclude+--min-filesize,--stats/--history/--json | jq,--autotune, and systemd scheduling.NO_COLOR,DUPEREMOVE_AUTOTUNE_*), FILES, and refreshed NOTES.completion/zsh/_oans: added the missing--autotune.Rendered clean with
pandoc 3.7/man; docs only, no code changes.🤖 Generated with Claude Code