X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=sic.1;h=aba8db8d9b7e4edbf2e36334b7ace0e0b064e100;hb=ec293427a0cc2ef7f561a60347ce940d567efb72;hp=2d453d374e3964af3ccd4b1ee41edaa87d6bd0f9;hpb=493bb0f4b36003e7ea4380f28e1fcf20b6d1fb21;p=sic.git diff --git a/sic.1 b/sic.1 index 2d453d3..aba8db8 100644 --- a/sic.1 +++ b/sic.1 @@ -1,37 +1,54 @@ -.TH SIC 1 sic-0.0 +.TH SIC 1 sic-VERSION .SH NAME sic \- simple irc client .SH SYNOPSIS .B sic +.RB [ \-h +.IR host ] +.RB [ \-p +.IR port ] +.RB [ \-n +.IR nick ] +.RB [ \-k +.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 \-v -Prints version information to standard output, then exits. +.BI \-h " host" +Overrides the default host (irc.oftc.net) +.TP +.BI \-p " port" +Overrides the default port (6667) +.TP +.BI \-n " nick" +Override the default nick ($USER) +.TP +.BI \-k " pass" +Specifies the PASS connection password +.TP +.B \-v +Prints version information to stderr, then exits .SH COMMANDS .TP -.BI /j " #channel/user " -join/query a channel/user +.BI :j " #channel" +Join a channel .TP -.BI /l " #channel " -leave a channel/query +.BI :l " #channel" +Leave a channel .TP -.BI /m " #channel/user msg " -write a message to #channel/user -.BI /t " topic" -set the channel topic +.BI :m " #channel/user message" +Send a message to 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 :s " #channel/user" +Set default channel or user +.TP +.BI : command +Any line beginning with +.B : +is sent as a command