Opened 9 years ago

Closed 5 years ago

Last modified 5 years ago

#127 closed Bug / Defect (fixed)

Updated manpage for --rport and --lport

Reported by: rf Owned by: rf
Priority: minor Milestone: release 2.3.7
Component: Documentation Version: OpenVPN 2.2-beta / 2.2-RC (Community Ed)
Severity: Not set (select this one, unless your'e a OpenVPN developer) Keywords: man documentation
Cc:

Description

Not sure about the wording (I'm not a native English speaker).

Attachments (2)

0001-Updated-documentation-for-rport-and-lport.patch (1.0 KB) - added by rf 9 years ago.
diff
0001-Updated-manpage-for-rport-and-lport.patch (1.5 KB) - added by rf 9 years ago.

Download all attachments as: .zip

Change History (17)

comment:1 Changed 9 years ago by David Sommerseth

The wording isn't bad. But I don't think the information is accurate enough.

--lport is the local port used when opening a connection. --rport is setting the remote port (the port to connect against). While --port sets both --lport and --rport to the same number (according to options.c).

However, it seems the default behaviour seems to differ, depending on if UDP or TCP is used, and on which platform. And you are correct, it may depend on if --bind is used or not as well.

We probably need a more careful and open wording here. And avoid using the 'default=1194', as that is only true if neither --port nor --lport or --rport is used.

comment:2 Changed 9 years ago by rf

I fully agree with your comments.

In my opinion, the manifold interactions between --port, --rport, --remote and --bind are not that easy to document by just adding the relevant information to each option.

Probably we should include some high level overview of the local and remote port selection process - perhaps with some examples or a simplified flowchart outlining the port selection logic.

Anyways, I'll try to come up with a new patch.

comment:3 Changed 9 years ago by David Sommerseth

Milestone: release 2.3release 2.2.1
Version: 2.3-beta / 2.3-RC2.2-beta / 2.2-RC

Any progress here? I'd like to add this one to the coming 2.2.1 release.

comment:4 Changed 9 years ago by David Sommerseth

Milestone: release 2.2.1release 2.2.2

As we're wrapping together a 2.2.1 nowadays, postponing this one.

comment:5 Changed 9 years ago by David Sommerseth

Would you have a chance to look at this again? I would appreciate to get this one closed.

comment:6 Changed 9 years ago by David Sommerseth

Owner: set to rf
Status: newassigned

comment:7 Changed 9 years ago by Samuli Seppänen

Milestone: release 2.2.2beta 2.3

comment:8 Changed 9 years ago by rf

I've tried to come up with a new version.
As said in my previous comment maybe it would be better to put all the specifics of --port, --rport, --remote, --bind combined with the permutations of using TCP or UDP on different platforms in a separate section of the manpage.

comment:9 Changed 8 years ago by David Sommerseth

Milestone: beta 2.3

comment:10 Changed 7 years ago by Samuli Seppänen

Milestone: release 2.4
Version: 2.2-beta / 2.2-RCgit master branch

I think this patch should be included in 2.4 in some format.

comment:11 Changed 7 years ago by Samuli Seppänen

Keywords: man documentation added

comment:12 Changed 5 years ago by Steffan Karger

Resolution: fixed
Status: assignedclosed

Wow, that took quite some time. But finally:

Your patch has been applied to the master and release/2.3 branch.

commit d3eacb2d6ebb8a42506343c54e00c72252d683f8 (master)
commit f1fa7e35cf7c7a11c27031c7eb35c3e730a450b6 (release/2.3)

Thanks for the patch and patience.

comment:13 Changed 5 years ago by Steffan Karger

Milestone: release 2.4release 2.3.7
Version: git master branch2.2-beta / 2.2-RC

comment:14 Changed 5 years ago by Samuli Seppänen

Fixed by commit d3eacb2d.

comment:15 in reply to:  14 Changed 5 years ago by Samuli Seppänen

Replying to samuli:

Fixed by commit d3eacb2d.

... as noted earlier in comments :).

Note: See TracTickets for help on using tickets.