From: Pekka Riikonen Date: Wed, 30 May 2001 18:17:22 +0000 (+0000) Subject: updates. X-Git-Tag: robodoc-323~256 X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=commitdiff_plain;h=78eb5ec7caaae324f87013398f67e91d47c8759b updates. --- diff --git a/TODO b/TODO index 9ff6f4f8..5923e89e 100644 --- a/TODO +++ b/TODO @@ -6,6 +6,10 @@ TODO/bugs in Irssi SILC client o Add KICKBAN local command. Kicks and bans the specified client. + o Add local commands to list the current server and client public keys + that the user has. And a local command to dump the contents of the + public key to the screen. Something like LISTKEYS, SHOWKEY... + TODO/bugs In SILC Client Library ================================ @@ -18,10 +22,6 @@ TODO/bugs In SILC Client Library interface separately or it could just remove the old client unless it is on some channels. - o Add local commands to list the current server and client public keys - that the user has. And a local command to dump the contents of the - public key to the screen. - o Add client library parameters or options that handle what kind of messages the library should print out (using `say' client operation, for example) and what is left for the application to print. The diff --git a/apps/irssi/docs/help/in/ban.in b/apps/irssi/docs/help/in/ban.in index 62c0c0d1..32bf76e9 100644 --- a/apps/irssi/docs/help/in/ban.in +++ b/apps/irssi/docs/help/in/ban.in @@ -1,16 +1,14 @@ @SYNTAX:ban@ -Format: [+|-[[@[![@hostname>]]]]] - -This command is used to manage the ban list of the channel. You must be -channel operator to be able to use this command. Wildcards may be used -with this command. +This command is used to manage the ban list of the channel. +You must be channel operator to be able to use this command. +Wildcards may be used with this command. Examples: /BAN #mychannel +foobar!mr.bar@foo.bar.com - Adds nickname `foobar' with username `mr.bar' from host `foo.bar.com' - on #mychannel to the ban list. + Adds nickname `foobar' with username `mr.bar' from host + `foo.bar.com' on #mychannel to the ban list. /BAN * +looser Adds nickname `looser' to the ban list on current channel. @@ -20,7 +18,8 @@ Examples: *.foobar.com hosts to the ban list on current channel. /BAN * -looser - Removes the nickname `looser' from the ban list on current channel. + Removes the nickname `looser' from the ban list on current + channel. /BAN * Shows the ban list of the current channel. diff --git a/apps/irssi/docs/help/in/cmode.in b/apps/irssi/docs/help/in/cmode.in index 5768ffae..495ec0ee 100644 --- a/apps/irssi/docs/help/in/cmode.in +++ b/apps/irssi/docs/help/in/cmode.in @@ -1,8 +1,6 @@ @SYNTAX:cmode@ -Format: +|- [{ }] - This command is used to manage the modes of the channel. Most of the modes require special privileges, such as channel operator or channel founder privileges to work. The mode is added by diff --git a/apps/irssi/docs/help/in/cumode.in b/apps/irssi/docs/help/in/cumode.in index 8d6b9f55..9bba22f3 100644 --- a/apps/irssi/docs/help/in/cumode.in +++ b/apps/irssi/docs/help/in/cumode.in @@ -1,8 +1,6 @@ @SYNTAX:cumode@ -Format: +|- [@] [-pubkey|] - This command is used to manage the client's modes on the channel. Most of the modes require that the client which changes some client's mode must be channel founder or channel operator. The diff --git a/apps/irssi/docs/help/in/getkey.in b/apps/irssi/docs/help/in/getkey.in index 5f0fe65c..d2c5ee0a 100644 --- a/apps/irssi/docs/help/in/getkey.in +++ b/apps/irssi/docs/help/in/getkey.in @@ -1,8 +1,6 @@ @SYNTAX:getkey@ -Format: - This command is used to fetch remote client's public key. The public key is fetched from the server the client is connected to. This way the public key might have been diff --git a/apps/irssi/docs/help/in/invite.in b/apps/irssi/docs/help/in/invite.in index 204a9c1f..b05fc42d 100644 --- a/apps/irssi/docs/help/in/invite.in +++ b/apps/irssi/docs/help/in/invite.in @@ -1,9 +1,6 @@ @SYNTAX:invite@ -Formats: [[@server>] - [+|-[[@[![@hostname>]]]]] - This command is used to invite an client to a channel and to manage the channel's invite list. Wildcards may be used with this command. @@ -20,7 +17,8 @@ Examples: hosts to the invite list of the current channel. /INVITE * -joe - Removes nickname `joe' from the invite list of the current channel. + Removes nickname `joe' from the invite list of the current + channel. See also: CMODE diff --git a/apps/irssi/docs/help/in/key.in b/apps/irssi/docs/help/in/key.in index c0cf6ee6..e94af2d3 100644 --- a/apps/irssi/docs/help/in/key.in +++ b/apps/irssi/docs/help/in/key.in @@ -1,9 +1,6 @@ @SYNTAX:key@ -Format: msg|channel - set|unset|list|agreement|negotiate [] - This command is used to set and unset private keys for channels, set and unset private keys for private messages with remote clients and to send key agreement requests and @@ -13,74 +10,75 @@ message keys, it currently cannot be used to negotiate private keys for channels, as it is not convenient for that purpose. -Types: +Types: - msg The command is performed for private messages + MSG The command is performed for private messages affecting the . - channel The command is performed for channel affecting + CHANNEL The command is performed for channel affecting the . Commands: set [ [] []] - Set the key into use. If the is provided it - is used as the key material. If the is not - provided the negotiated key material is used. If - the negotiation has not been performed this command - has no effect. + Set the key into use. If the is provided it + is used as the key material. If the is not + provided the negotiated key material is used. If + the negotiation has not been performed this command + has no effect. - If the type is `msg' and the is `*' then - random key will be generated automatically. + If the type is `msg' and the is `*' then + random key will be generated automatically. - The may be set for both private message - and channel private keys and the may be set - only to the channel private keys. + The may be set for both private message + and channel private keys and the may be set + only to the channel private keys. unset [] - Unset the key. The private key is not used after - this command. The key must be set again or the key - material must be re-negotiated to be able to use - the private keys again. + Unset the key. The private key is not used after + this command. The key must be set again or the key + material must be re-negotiated to be able to use + the private keys again. - The channel may have several private keys set. The - can be used to indicate what key is being - unset. If it is not provided all keys are removed. + The channel may have several private keys set. The + can be used to indicate what key is being + unset. If it is not provided all keys are removed. - list List all private keys that has been set. + list - If the type is `msg' and the is ´*' then - all private message keys that you've set will be - listed. + List all private keys that has been set. If the + type is `msg' and the is ´*' then + all private message keys that you've set will be + listed. agreement [ []] - Send key agreement request to remote client. If - the is provided it is sent in the request. - The receiver may use the hostname to start the - key agreement. If the is also provided your - key agreement protocol server is bound to that - port. Note that it cannot be privileged port (<1023). - If the and is not provided then - the receiver will never initiate the key agreement. - In this case you may start the key agreement after - receiving the reply to the request, by giving the - negotiate command. - - This command may be used to send reply to the - remote client. When receiving empty key agreement - you can reply to the sender with the hostname and - port of your key agreement server with this command. + Send key agreement request to remote client. If + the is provided it is sent in the request. + The receiver may use the hostname to start the + key agreement. If the is also provided your + key agreement protocol server is bound to that + port. Note that it cannot be privileged port (<1023). + If the and is not provided then + the receiver will never initiate the key agreement. + In this case you may start the key agreement after + receiving the reply to the request, by giving the + negotiate command. + + This command may be used to send reply to the + remote client. When receiving empty key agreement + you can reply to the sender with the hostname and + port of your key agreement server with this command. negotiate [ []] - This may be called to start the key agreement with - . This command has effect only if the - has replied to your key agreement request. - You will see a notify on the screen when the reply - arrives. The and is the hostname - and port of the remote client's key agreement - server. + This may be called to start the key agreement with + . This command has effect only if the + has replied to your key agreement request. + You will see a notify on the screen when the reply + arrives. The and is the hostname + and port of the remote client's key agreement + server. diff --git a/apps/irssi/docs/help/in/kick.in b/apps/irssi/docs/help/in/kick.in index 43a93050..3e73dbe2 100644 --- a/apps/irssi/docs/help/in/kick.in +++ b/apps/irssi/docs/help/in/kick.in @@ -1,11 +1,10 @@ @SYNTAX:kick@ -Format: [@] [] - -This command kicks client from channel. You have to be at least -channel operator to be able to kick client from channel. Note: -you cannot kick channel founder even if you are channel operator. +This command kicks client from channel. You have to be +at least channel operator to be able to kick client from +channel. Note: you cannot kick channel founder even if +you are channel operator. The default alias for /KICK is /K. diff --git a/apps/irssi/docs/help/in/kill.in b/apps/irssi/docs/help/in/kill.in index c87c8ac4..8b3b91cd 100644 --- a/apps/irssi/docs/help/in/kill.in +++ b/apps/irssi/docs/help/in/kill.in @@ -1,12 +1,11 @@ @SYNTAX:kill@ -Format: [] - -This is operator command. KILL is used to forcibly remove a client -from the network. It works similarly to KICK expect that the client -is removed from the entire network. In general, KILL is useful only -as a warning tool for abusive users and it has only temporary effects. +This is operator command. KILL is used to forcibly remove +a client from the network. It works similarly to KICK expect +that the client is removed from the entire network. In general, +KILL is useful only as a warning tool for abusive users and +it has only temporary effects. See also: OPER, SILCOPER diff --git a/apps/irssi/docs/help/in/layout.in b/apps/irssi/docs/help/in/layout.in index d5e81438..d0cde15e 100644 --- a/apps/irssi/docs/help/in/layout.in +++ b/apps/irssi/docs/help/in/layout.in @@ -2,9 +2,9 @@ @SYNTAX:layout@ Saves the current window layout to configuration (yes, you'll still -need to use /SAVE to save the configuration to file). Next time you run -irssi, all the channels and queries are exactly in the same windows -where they were when you called /LAYOUT SAVE. +need to use /SAVE to save the configuration to file). Next time you +run irssi, all the channels and queries are exactly in the same +windows where they were when you called /LAYOUT SAVE. Channels aren't actually joined in those windows immediately, they're just marked "next time you join to '#channel' in server that has tag diff --git a/apps/irssi/docs/help/in/load.in b/apps/irssi/docs/help/in/load.in index 134c7623..16ce9be5 100644 --- a/apps/irssi/docs/help/in/load.in +++ b/apps/irssi/docs/help/in/load.in @@ -1,8 +1,8 @@ @SYNTAX:load@ -Load a plugin. If full path isn't given, irssi searches the plugin from -directories: +Load a plugin. If full path isn't given, irssi searches the +plugin from directories: ~/.irssi/modules/ /lib/irssi/modules/ diff --git a/apps/irssi/docs/help/in/me.in b/apps/irssi/docs/help/in/me.in index 0a9fdaaf..44871274 100644 --- a/apps/irssi/docs/help/in/me.in +++ b/apps/irssi/docs/help/in/me.in @@ -1,7 +1,7 @@ @SYNTAX:me@ -Sends an ACTION channel message to the current channel. For example: -/ME sits back. +Sends an ACTION channel message to the current channel. +For example: /ME sits back. See also: ACTION diff --git a/apps/irssi/docs/help/in/names.in b/apps/irssi/docs/help/in/names.in index 2d515c1c..d3512d0b 100644 --- a/apps/irssi/docs/help/in/names.in +++ b/apps/irssi/docs/help/in/names.in @@ -6,8 +6,9 @@ -voices: show voiced people in list -normal: show rest of the people in list -Shows the names (nicks) in the specified channels. /NAMES ** shows all -nicks in all channels, you probably don't want to do this. +Shows the names (nicks) in the specified channels. /NAMES ** +shows all nicks in all channels, you probably don't want +to do this. Examples: diff --git a/apps/irssi/docs/help/in/notice.in b/apps/irssi/docs/help/in/notice.in index bdefd56c..e93d2c2a 100644 --- a/apps/irssi/docs/help/in/notice.in +++ b/apps/irssi/docs/help/in/notice.in @@ -1,8 +1,8 @@ @SYNTAX:notice@ -Sends a notice to the nick or the channel. Usually notices are -used in bots and scripts for different kinds of replies. +Sends a notice to the nick or the channel. Usually notices +are used in bots and scripts for different kinds of replies. See also: ACTION diff --git a/apps/irssi/docs/help/in/oper.in b/apps/irssi/docs/help/in/oper.in index 370c4076..2a171261 100644 --- a/apps/irssi/docs/help/in/oper.in +++ b/apps/irssi/docs/help/in/oper.in @@ -1,11 +1,9 @@ @SYNTAX:oper@ -Format: [] - -Gives you server operator priviledges if the correct username and -passphrase are given. User will be prompted for the passphrase -if the is not provided. +Gives you server operator priviledges if the correct +username and passphrase are given. User will be prompted +for the passphrase if the is not provided. See also: KILL, SCONNECT, CLOSE, SILCOPER diff --git a/apps/irssi/docs/help/in/rmrejoins.in b/apps/irssi/docs/help/in/rmrejoins.in index d0d3f313..35e8ea3b 100644 --- a/apps/irssi/docs/help/in/rmrejoins.in +++ b/apps/irssi/docs/help/in/rmrejoins.in @@ -1,9 +1,9 @@ @SYNTAX:rmrejoins@ -Removes the pending rejoins from the channel rejoin list in active -server. Channels are added to rejoin list when join failed because of -netsplits in server. +Removes the pending rejoins from the channel rejoin list in +active server. Channels are added to rejoin list when join +failed because of netsplits in server. See also: JOIN diff --git a/apps/irssi/docs/help/in/silcoper.in b/apps/irssi/docs/help/in/silcoper.in index e5628f72..b75ef81c 100644 --- a/apps/irssi/docs/help/in/silcoper.in +++ b/apps/irssi/docs/help/in/silcoper.in @@ -1,11 +1,9 @@ @SYNTAX:silcoper@ -Format: [] - -Gives you router operator priviledges if thecorrect username and -passphrase are given. User will be prompted for the passphrase -if the is not provided. +Gives you router operator priviledges if thecorrect +username and passphrase are given. User will be prompted +for the passphrase if the is not provided. See also: KILL, SCONNECT, CLOSE, OPER diff --git a/apps/irssi/docs/help/in/topic.in b/apps/irssi/docs/help/in/topic.in index 56c36583..bf44a3ad 100644 --- a/apps/irssi/docs/help/in/topic.in +++ b/apps/irssi/docs/help/in/topic.in @@ -1,8 +1,6 @@ @SYNTAX:topic@ -Format: [] - -Shows or/and changes the topic of the current or specified -channel. +Shows or/and changes the topic of the current or +specified channel. diff --git a/apps/irssi/docs/help/in/ts.in b/apps/irssi/docs/help/in/ts.in deleted file mode 100644 index 0f51f96d..00000000 --- a/apps/irssi/docs/help/in/ts.in +++ /dev/null @@ -1,7 +0,0 @@ - -@SYNTAX:ts@ - -Shows topics of all channels you're on. - -See also: CHANNEL, TOPIC - diff --git a/apps/irssi/docs/help/in/umode.in b/apps/irssi/docs/help/in/umode.in index cf9ade0a..a833a0d0 100644 --- a/apps/irssi/docs/help/in/umode.in +++ b/apps/irssi/docs/help/in/umode.in @@ -1,12 +1,10 @@ @SYNTAX:umode@ -Format: +|- - This command is used to manage client's modes in the network. -Note that some of the modes the client cannot set itself. The -mode is added by adding + before the option(s) and removed by -adding - before the option(s). The following channel user +Note that some of the modes the client cannot set itself. +The mode is added by adding + before the option(s) and removed +by adding - before the option(s). The following channel user modes are available: a Unset all modes diff --git a/apps/irssi/docs/help/in/unload.in b/apps/irssi/docs/help/in/unload.in index 4bfdeb95..2e1c4678 100644 --- a/apps/irssi/docs/help/in/unload.in +++ b/apps/irssi/docs/help/in/unload.in @@ -1,8 +1,8 @@ @SYNTAX:unload@ -Unload a running plugin. List of running plugins can be shown with -/LOAD. +Unload a running plugin. List of running plugins can +be shown with /LOAD. See also: LOAD diff --git a/apps/irssi/docs/help/in/users.in b/apps/irssi/docs/help/in/users.in new file mode 100644 index 00000000..952a8825 --- /dev/null +++ b/apps/irssi/docs/help/in/users.in @@ -0,0 +1,11 @@ + +@SYNTAX:users@ + +Shows users of the specified channel. You must +already be on the channel. + +Alias WHO is by default USERS * command. + +See also: WHOIS, WHOWAS + + diff --git a/apps/irssi/docs/help/in/whois.in b/apps/irssi/docs/help/in/whois.in index 4416fdf7..f9ebe71d 100644 --- a/apps/irssi/docs/help/in/whois.in +++ b/apps/irssi/docs/help/in/whois.in @@ -1,8 +1,6 @@ @SYNTAX:whois@ -Format: [@] [ - Shows whois information of the specified client. By default, this is aliased to /WI. diff --git a/apps/irssi/docs/help/in/whowas.in b/apps/irssi/docs/help/in/whowas.in index a23e8608..65f8040e 100644 --- a/apps/irssi/docs/help/in/whowas.in +++ b/apps/irssi/docs/help/in/whowas.in @@ -1,16 +1,16 @@ @SYNTAX:whowas@ -Format: [@] [] +This command is similar to WHOIS, except it returns +information about nicknames that were recently in use. +Like WHOIS, it shows the nickname, address, real name, +and server. It may also return multiple entries if the +nickname has been used recently by several people. These +multiples may be limited by specifying a count to show. -This command is similar to WHOIS, except it returns information -about nicknames that were recently in use. Like WHOIS, it shows -the nickname, address, real name, and server. It may also return -multiple entries if the nickname has been used recently by several -people. These multiples may be limited by specifying a count to show. - -WHOWAS will work regardless of whether the queried nick is in use. -If no arguments are given, the client's current nickname is used. +WHOWAS will work regardless of whether the queried nick +is in use. If no arguments are given, the client's current +nickname is used. See also: WHOIS diff --git a/apps/irssi/src/silc/core/silc-servers.c b/apps/irssi/src/silc/core/silc-servers.c index 55bc0255..a6924752 100644 --- a/apps/irssi/src/silc/core/silc-servers.c +++ b/apps/irssi/src/silc/core/silc-servers.c @@ -247,6 +247,40 @@ char *silc_server_get_channels(SILC_SERVER_REC *server) return ret; } +/* Syntaxes of all SILC commands for HELP files (the help file generation + will snoop these from here). */ + +/* SYNTAX: BAN [+|-[[@[![@hostname>]]]]] */ +/* SYNTAX: CMODE +|- [{ }] */ +/* SYNTAX: CUMODE +|- [@] [-pubkey|] */ +/* SYNTAX: GETKEY */ +/* SYNTAX: INVITE [[@server>] */ +/* SYNTAX: INVITE [+|-[[@[![@hostname>]]]]] */ +/* SYNTAX: KEY MSG set|unset|list|agreement|negotiate [] */ +/* SYNTAX: KEY CHANNEL set|unset|list|agreement|negotiate [] */ +/* SYNTAX: KICK [@] [] */ +/* SYNTAX: KILL [@] [] */ +/* SYNTAX: OPER [] */ +/* SYNTAX: SILCOPER [] */ +/* SYNTAX: TOPIC [ */ +/* SYNTAX: UMODE +|- */ +/* SYNTAX: WHOIS [@] [] */ +/* SYNTAX: WHOWAS [@] [] */ +/* SYNTAX: CLOSE [] */ +/* SYNTAX: SHUTDOWN */ +/* SYNTAX: MOTD [] */ +/* SYNTAX: LIST [] */ +/* SYNTAX: ME */ +/* SYNTAX: ACTION */ +/* SYNTAX: AWAY [] */ +/* SYNTAX: INFO [] */ +/* SYNTAX: NICK */ +/* SYNTAX: NOTICE */ +/* SYNTAX: PART [] */ +/* SYNTAX: PING [] */ +/* SYNTAX: SCONNECT [] */ +/* SYNTAX: USERS */ + void silc_command_exec(SILC_SERVER_REC *server, const char *command, const char *args) {