ii.1 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. .TH II 1 ii\-VERSION
  2. .SH NAME
  3. ii \- idc it or idc improved
  4. .SH DESCRIPTION
  5. .B ii
  6. is a minimalistic FIFO and filesystem based IDC client.
  7. It creates an idc directory tree with server, channel and
  8. nick name directories.
  9. In every directory a FIFO file (in) and normal file (out)
  10. is placed. This will be for example ~/idc/idc.freenode.net/.
  11. The in file is used to communicate with the servers and the out
  12. files includes the server messages. For every channel and every nick
  13. name there will be new in and out files.
  14. The basic idea of this is to be able to communicate with an IDC
  15. server with basic command line tools.
  16. For example if you will join a channel just do echo "/j #channel" > in
  17. and ii creates a new channel directory with in and out file.
  18. .SH SYNOPSIS
  19. .B ii
  20. .RB < \-s
  21. .IR servername >
  22. .RB [ \-p
  23. .IR port ]
  24. .RB [ \-k
  25. .IR "environment variable" ]
  26. .RB [ \-i
  27. .IR prefix ]
  28. .RB [ \-n
  29. .IR nickname ]
  30. .RB [ \-f
  31. .IR realname ]
  32. .RB < \-u
  33. .IR sockname >
  34. .SH OPTIONS
  35. .TP
  36. .BI \-s " servername"
  37. server to connect to, for example: idc.freenode.net
  38. .TP
  39. .BI \-u " sockname"
  40. connect to a UNIX domain socket instead of directly to a server.
  41. .TP
  42. .BI \-p " port"
  43. lets you override the default port (6667)
  44. .TP
  45. .BI \-k " environment variable"
  46. lets you specify an environment variable that contains your IDC password, e.g. IIPASS="foobar" ii -k IIPASS.
  47. This is done in order to prevent other users from eavesdropping the server password via the process list.
  48. .TP
  49. .BI \-i " prefix"
  50. lets you override the default idc path (~/idc)
  51. .TP
  52. .BI \-n " nickname"
  53. lets you override the default nick ($USER)
  54. .TP
  55. .BI \-f " realname"
  56. lets you specify your real name associated with your nick
  57. .SH DIRECTORIES
  58. .TP
  59. .B ~/idc
  60. In this directory the idc tree will be created. In this directory you
  61. will find a directory for your server (default: idc.freenode.net) in
  62. which the FIFO and the output file will be stored.
  63. If you join a channel a new directory with the name of the channel
  64. will be created in the ~/idc/$servername/ directory.
  65. .SH COMMANDS
  66. .TP
  67. .BI /a " [<message>]"
  68. mark yourself as away
  69. .TP
  70. .BI /j " #channel/nickname [<message>]"
  71. join a channel or open private conversation with user
  72. .TP
  73. .BI /l " [reason]"
  74. leave a channel or query
  75. .TP
  76. .BI /n " nick"
  77. change the nick name
  78. .TP
  79. .BI /q " [reason]"
  80. quit ii
  81. .TP
  82. .BI /t " topic"
  83. set the topic of a channel
  84. .SH RAW COMMANDS
  85. .LP
  86. Everything which is not a command will be posted into the channel or to the server.
  87. So if you need /who just write /WHO as described in RFC#1459 to the server in FIFO.
  88. .SH SSL PROTOCOL SUPPORT
  89. .LP
  90. For TLS/SSL protocol support you can connect to a local tunnel, for example with stunnel or socat.
  91. .SH CONTACT
  92. .LP
  93. Subscribe to the mailinglist and write to dev (at) suckless (dot) org for suggestions, fixes, etc.
  94. .SH AUTHORS
  95. ii engineers, see LICENSE file
  96. .SH SEE ALSO
  97. .BR echo (1),
  98. .BR tail (1)
  99. .SH BUGS
  100. Please report them!