#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)
Change History (17)
Changed 13 years ago by
| Attachment: | 0001-Updated-documentation-for-rport-and-lport.patch added |
|---|
comment:1 Changed 13 years ago by
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 13 years ago by
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 13 years ago by
| Milestone: | release 2.3 → release 2.2.1 |
|---|---|
| Version: | 2.3-beta / 2.3-RC → 2.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 13 years ago by
| Milestone: | release 2.2.1 → release 2.2.2 |
|---|
As we're wrapping together a 2.2.1 nowadays, postponing this one.
comment:5 Changed 13 years ago by
Would you have a chance to look at this again? I would appreciate to get this one closed.
comment:6 Changed 13 years ago by
| Owner: | set to rf |
|---|---|
| Status: | new → assigned |
comment:7 Changed 13 years ago by
| Milestone: | release 2.2.2 → beta 2.3 |
|---|
Changed 13 years ago by
| Attachment: | 0001-Updated-manpage-for-rport-and-lport.patch added |
|---|
comment:8 Changed 13 years ago by
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 12 years ago by
| Milestone: | beta 2.3 |
|---|
comment:10 Changed 11 years ago by
| Milestone: | → release 2.4 |
|---|---|
| Version: | 2.2-beta / 2.2-RC → git master branch |
I think this patch should be included in 2.4 in some format.
comment:11 Changed 11 years ago by
| Keywords: | man documentation added |
|---|
comment:12 Changed 9 years ago by
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
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 9 years ago by
| Milestone: | release 2.4 → release 2.3.7 |
|---|---|
| Version: | git master branch → 2.2-beta / 2.2-RC |
diff