Skip to content

docs: audit and update man page for current codebase#312

Merged
spe-ciellt merged 1 commit intogerbv:developfrom
SourceParts:docs/man-page-audit
Mar 2, 2026
Merged

docs: audit and update man page for current codebase#312
spe-ciellt merged 1 commit intogerbv:developfrom
SourceParts:docs/man-page-audit

Conversation

@rampageservices
Copy link
Copy Markdown
Contributor

@rampageservices rampageservices commented Mar 1, 2026

Summary

The man page (gerbv.1.in) was last updated July 2013 and had several discrepancies with the current codebase. This PR brings it up to date.

Changes

  • Fix header date typo: "Jule 13, 2013" (typo + stale)
  • Remove dead link: http://pcb.geda-project.org/ is no longer active
  • Add missing CLI options: -r, --rotate and -m, --mirror are implemented in main.c but were never documented in the man page
  • Update export format list: the man page listed png/pdf/ps/svg/rs274x/drill but idrill (ISEL NCP drill) is always available and dxf is conditionally available when compiled with libdxflib
  • Remove outdated scroll wheel instructions: "if you enabled that in your X server and mapped it to button 4 and 5" hasn't been relevant in 15+ years
  • Update SUPERIMPOSING section: described only legacy GDK compositing modes (GDK_COPY, GDK_XOR, etc.) without mentioning Cairo, which has been the default renderer since ~2.7. Updated to describe Cairo's alpha transparency behavior as the primary mode, with GDK modes noted as legacy

Not changed (questions for @spe-ciellt)

  • Copyright years (2001-2008) and AUTHOR section: Left as-is. The existing CONTRIBUTORS file tracks contributors — should the man page copyright years be extended, or is the current range intentional (covering the original authorship period)?
  • -d, --dump option: Intentionally undocumented (debug flag, not in --help output either)

Test plan

  • cmake --build build — clean build
  • man -l build/man/gerbv.1 — renders correctly, no formatting issues

- Fix header date typo ("Jule" -> correct date)
- Remove dead pcb.geda-project.org link
- Add missing -r/--rotate and -m/--mirror options
- Update export format list: add idrill and conditional dxf
- Remove outdated X server scroll wheel mapping instructions
- Update SUPERIMPOSING section for Cairo renderer (default since ~2.7)
@spe-ciellt spe-ciellt added the documentation Improvements or additions to documentation label Mar 1, 2026
@spe-ciellt
Copy link
Copy Markdown
Contributor

Great question @rampageservices .

Never thought of who the AUTHORS and COPYRIGHT was in those man pages. And that it was written like that.

For copyright you can probably set me 2001-2026 if you think it sounds OK. For the Authors we should maybe create a THANKS file as curl have?

But I will merge this now so it is more correct regarding the other stuff.

@spe-ciellt spe-ciellt merged commit e3beea0 into gerbv:develop Mar 2, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants