lhost / sendxmpp

perl-script to send xmpp (jabber), similar to what mail(1) does for mail.
64 stars 22 forks source link

Remove "I<>" from manpage #23

Closed andrey-utkin closed 7 years ago

andrey-utkin commented 8 years ago

Hi, and thanks for awesome software!

Currently I have net-im/sendxmpp-1.24 installed in my Gentoo. Config example in manpage looks this way:

CONFIGURATION FILE
       You may define a '~/.sendxmpprc' file with the necessary data for your xmpp-account. Since version 1.24 the following format is supported:

           username: I<your_username>
           jserver: I<jabber_server>
           port: I<jabber_port>
           password: I<your_jabber_password>
           component: I<optional_component_name>

       Example for Google Talk servers:

           username: I<lubomir.host>
           jserver: I<talk.google.com>
           password: I<my-secure-password>
           component: I<gmail.com>

This I<> stuff seems serving purpose of formatting, but it doesn't really work. It comes at a cost because I lost some time trying with config file actually having those symbols.

micha137 commented 7 years ago

You have to read the manpage with man, not as plain Text.

lhost commented 7 years ago

You shuld read documentation with this command:

perldoc ./sendxmpp

But you are right - markers I<> doesn't work. I remove these markers from configuration example (other places are OK). Commited, pushed. Thanks for your report.