xpra icon
Bug tracker and wiki

#2572 closed enhancement (fixed)

Man page cleanup

Reported by: Bill Randle Owned by: Antoine Martin
Priority: minor Milestone: 4.0
Component: packaging Version: 3.0.x
Keywords: Cc:

Description

From looking at the code, it appears the use of CONNECTIONSTRING applies to the start, start-desktop modes and shadow modes, as well sd attach and control. I think it would make things clearer to show this in the synopsis entries and update the examples to use the newer preferred protocol:// syntax.

The example entry:

xpra attach ssh://foo@frodo:7

is just plain wrong and won't work. I kept having problems attaching to a remote server until I looked closer at the CONNECTIONSTRINGS section and realized the example should have been:

xpra attach ssh://foo@frodo/7

There also seems to be a misplaced : in the upgrade synopsis entries, where it shows :[DISPLAY] rather than [:DISPLAY]. It wasn't clear if upgrade supports a connection string.

I've attached a proposed diff for the man page. You are welcome to use all or none. As a final note, there is no documentation component for tickets, so I used packaging.

Attachments (1)

xpra.1.diff (5.4 KB) - added by Bill Randle 10 months ago.
man page diff

Download all attachments as: .zip

Change History (2)

Changed 10 months ago by Bill Randle

Attachment: xpra.1.diff added

man page diff

comment:1 Changed 10 months ago by Antoine Martin

Resolution: fixed
Status: newclosed

Thanks!

Applied in r25133. (r25134 for v3.0.x)

Note: See TracTickets for help on using tickets.