Skip to content

docs: sync translated MANPAGER examples#3830

Open
JSap0914 wants to merge 2 commits into
sharkdp:masterfrom
JSap0914:codex/3730-manpager-docs
Open

docs: sync translated MANPAGER examples#3830
JSap0914 wants to merge 2 commits into
sharkdp:masterfrom
JSap0914:codex/3730-manpager-docs

Conversation

@JSap0914

@JSap0914 JSap0914 commented Jul 4, 2026

Copy link
Copy Markdown

Summary

  • Align the Chinese, Japanese, Korean, and Russian MANPAGER examples with the current English README's bat -plman guidance.
  • Remove stale col/awk pre-filtering, MANROFFOPT, and old Mandoc shell-wrapper notes that predate bat's built-in overstrike handling for Manpage/Command Help syntax.
  • Correct the Chinese Debian/Ubuntu note so it no longer reverses bat and batcat.

Fixes #3730.

Verification

  • gh pr list -R sharkdp/bat --state open --search "3730 doc inconsistency readme manpager language help" --json number,title,url,headRefName,author
  • git diff --check
  • cargo test --doc
  • cargo test --test integration_tests strip_overstrike
  • cargo test test_strip_overstrike
  • ./target/debug/bat --help --color=never --decorations=never --paging=never | rg -n -- '--language|--strip-ansi|--help'
  • printf 'B\bBold _\bunder\n' | ./target/debug/bat --color=always --decorations=never --paging=never --language=man | python3 -c 'import sys; data=sys.stdin.buffer.read(); print("contains_backspace=", b"\\x08" in data); print("contains_Bold=", b"Bold" in data); print("bytes=", data[:80])'
  • rg -n 'const MANPAGE_SYNTAX|const COMMAND_HELP_SYNTAX|strip_overstrike|language: if use_color|bat -plman|col -bx|awk|MANROFFOPT|Mandoc' README.md doc/README-zh.md doc/README-ru.md doc/README-ko.md doc/README-ja.md src/bin/bat/app.rs src/printer.rs src/preprocessor.rs tests/integration_tests.rs

Copilot AI review requested due to automatic review settings July 4, 2026 21:44

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

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.

Doc inconsistency among several README.md

2 participants