X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=sic.1;h=aba8db8d9b7e4edbf2e36334b7ace0e0b064e100;hb=ec293427a0cc2ef7f561a60347ce940d567efb72;hp=4230bbd1bf2bc7bc37d186a4f8b92adbea5e454b;hpb=37ca48e77061721bc0d2e133c088995c1548c337;p=sic.git diff --git a/sic.1 b/sic.1 index 4230bbd..aba8db8 100644 --- a/sic.1 +++ b/sic.1 @@ -1,67 +1,54 @@ -.TH SIC 1 sic-0.0 +.TH SIC 1 sic-VERSION .SH NAME sic \- simple irc client .SH SYNOPSIS .B sic -.RB [ \-s -.IR server ] +.RB [ \-h +.IR host ] .RB [ \-p .IR port ] .RB [ \-n .IR nick ] .RB [ \-k -.IR keyword ] -.RB [ \-f -.IR fullname ] -.RB \-v +.IR pass ] .RB [ \-v ] .SH DESCRIPTION .B sic -is an extremly fast, small and simple irc client. It reads commands from -standard input and prints all server output to standard output. It multiplexes -also all channel traffic into one output, that you don't have to switch -different channel buffers, that's actually a feature. +is an extremely fast, small and simple irc client. It reads commands from +standard input and prints all server output to standard output. It also +multiplexes all channel traffic into one output. That way you don't have to +switch different channel buffers. So that's actually a feature. .SH OPTIONS .TP -.BI \-s " server" -Overrides the default server (irc.oftc.net) +.BI \-h " host" +Overrides the default host (irc.oftc.net) .TP .BI \-p " port" Overrides the default port (6667) .TP -.BI \-n " nickname" +.BI \-n " nick" Override the default nick ($USER) .TP -.BI \-k " keyword" -Specifies the keyword to authenticate your nick on the server +.BI \-k " pass" +Specifies the PASS connection password .TP -.BI \-f " fullname" -Specify the real name (default is $USER) -.TP -.BI \-v -Prints version information to standard output, then exits. +.B \-v +Prints version information to stderr, then exits .SH COMMANDS .TP -.BI /j " #channel " +.BI :j " #channel" Join a channel .TP -.BI /l " #channel " +.BI :l " #channel" Leave a channel .TP -.BI /m " #channel/user msg " -Write a message to #channel/user -.TP -.BI /s " #channel/user " -Set default channel/user +.BI :m " #channel/user message" +Send a message to channel or user .TP -.BI /t " topic" -Set the channel topic +.BI :s " #channel/user" +Set default channel or user .TP -Everything which is not a command will simply be posted into the channel or to -the server. -.SH CUSTOMIZATION -.B sic -is customized through editing its source code. This keeps it fast, secure and -simple. The source code contains the -.I CUSTOMIZE -keyword to highlight relevant portions for customization. +.BI : command +Any line beginning with +.B : +is sent as a command