Compiz man pages are out of date, and should really be upstream

Bug #924685 reported by Daniel van Vugt
22
This bug affects 4 people
Affects Status Importance Assigned to Milestone
Compiz
Triaged
Medium
Unassigned
Compiz Core
Triaged
Medium
Unassigned
compiz (Ubuntu)
Triaged
Medium
Unassigned

Bug Description

Test case: man compiz
You will see outdated information.

Sure, we could fix this easily, but it's surprising to see that the man pages don't come from upstream. They come from debian branches only...

/usr/share/man/man1/compiz.1.gz
/usr/share/man/man1/compiz-decorator.1.gz
/usr/share/man/man1/gtk-window-decorator.1.gz
/usr/share/man/man1/kde4-window-decorator.1.gz

I suggest:
1. The source for the man pages needs to be copied upstream into lp:compiz-core, and an appropriate install rule added.
2. The man pages in lp:compiz-core then need to be updated with the latest command line options (several old options need deleting).
3. Re-sync lp:compiz from lp:compiz-core and update debian/ in lp:compiz. Removing the old man pages.

Tags: manpage
affects: compiz → compiz (Ubuntu)
description: updated
tags: added: manpage
Revision history for this message
jhfhlkjlj (fdsuufijjejejejej-deactivatedaccount) wrote :

I have experience writing man pages. However, not being an experienced programmer I'd need some aid in navigating and finding all of the proper flags. If you point me in the right direction I can do it, Mr. Vugt.

Changed in compiz (Ubuntu):
importance: Undecided → Low
status: New → Triaged
Changed in compiz-core:
status: New → Confirmed
Revision history for this message
Sam Spilsbury (smspillaz) wrote :

compiz --help would indicate these

Options:
  --replace Replace any existing window managers
  --display DISPLAY Connect to X display DISPLAY (instead of $DISPLAY)
  --sm-disable Disable session management
  --sm-client-id ID Session management client ID
  --keep-desktop-hints Retain existing desktop hints
  --sync Make all X calls synchronous
  --debug Enable debug mode
  --version Show the program version
  --help Show this summary

I don't really know if the various options really belong in the manpage however, they're mostly used by distributions.

Changed in compiz:
status: New → Confirmed
Changed in compiz:
importance: Undecided → Medium
Changed in compiz-core:
importance: Undecided → Medium
Changed in compiz (Ubuntu):
importance: Low → Medium
Changed in compiz:
status: Confirmed → Triaged
Changed in compiz-core:
status: Confirmed → Triaged
Revision history for this message
MC Return (mc-return) wrote :

We should really fix that.

MC Return (mc-return)
Changed in compiz:
milestone: none → 0.9.10.0
Changed in compiz:
milestone: 0.9.10.0 → 0.9.10.2
MC Return (mc-return)
Changed in compiz:
milestone: 0.9.10.2 → 0.9.11.0
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.