Suggestion: Better documentation for "/server add server hostname"
berndbausch opened this issue · 5 comments
It might be obvious for people who have been using IRC, but a total newbie like me is quite confused by this line in the quick start guide:
/server add <server> <hostname>[/<port>]
I spent 15 minutes wondering and searching the internet to understand the meanings of server versus hostname. When I see <server>, I think "hostname of a server". So, why enter the server name twice?
Later, it dawned to me that <server> is not an attribute of the IRC server, and that I can replace it with any string I want. E.g. after /server alberteinstein chat.freenode.net, I can access the freenode IRC server with /connect alberteinstein.
Would be nice if this were documented somewhere, especially in the quickstart document.
Well, there is also a /help server with examples:
/server add chatspike irc.chatspike.net/6667,irc.duckspike.net/6667
/server add freenode chat.freenode.net/6697 -ssl -autoconnect
and in the /help for the <server> and <hostname> arguments:
server: server name, for internal and display use
hostname: name or IP address of server, with optional port (default: 6667), many addresses can be separated by a comma
The Quick Start Guide also points to /help server:
As usual, help is available if you’re lost:
I don't know how to make it more clearer. Any suggestions!?
I'll update the quickstart guide and /help server to explicit the difference between the server name and hostname (and rename arguments in the command help).
By the way this is a weechat issue, not weechat.org site. Please open the issue in weechat repository, I'm closing this one.
Can I still comment? Yes, Nils (weechatter) is right of course. However, this is a "first steps" page and attracts people like me :) A one-liner would be sufficient to clarify this.
Thanks for addressing my nit.
@berndbausch: done via 2 commits: weechat/weechat@70892bf and weechat/weechat@974c25d
Is that OK for you now?