X-Git-Url: https://sipb.mit.edu/gitweb.cgi/wiki.git/blobdiff_plain/8f399eec1aba7a2163e88903bc25a868793ed182..bb6fd584661e48027da4137d153fa6062a070ff8:/doc/UsingZephyr?ds=sidebyside diff --git a/doc/UsingZephyr b/doc/UsingZephyr index 266185f..ddef7f7 100644 --- a/doc/UsingZephyr +++ b/doc/UsingZephyr @@ -64,19 +64,25 @@ For more documentation on the built-in commands and keybindings, you can press h === Classes and Instances === -Generall the most interesting discussion on Zephyr, however, happens on so-called Zephyr ''classes''. A class is a bit like a chat room in other IM systems. Anyone can send a zephyr to a class, and anyone who is subscribed to that class will receive it. There is no security on classes -- anyone who knows the name of a class can subscribe, and there is no way to determine who is subscribed to a given class. +Generally the most interesting discussion on Zephyr, however, happens on so-called Zephyr ''classes''. A class is a bit like a chat room in other IM systems. Anyone can send a zephyr to a class, and anyone who is subscribed to that class will receive it. There is no security on classes -- anyone who knows the name of a class can subscribe, and there is no way to determine who is subscribed to a given class. To subscribe to a class, use the subscribe command: -{{{:subscribe CLASSNAME * *}}} +{{{ +:subscribe CLASSNAME * * +}}} To send a zephyr to a class, use the zwrite command with the -c option: -{{{:zwrite -c CLASSNAME}}} +{{{ +:zwrite -c CLASSNAME +}}} Zephyrs to classes usually have an instance attached. An instance is a short “topic” or “subject” that indicates the context of a zephyr. Different instances are often used to multiplex multiple conversations on a high-traffic class. You can specify an instance with the -i option to zwrite: -{{{:zwrite -c CLASSNAME -i INSTANCE}}} +{{{ +:zwrite -c CLASSNAME -i INSTANCE +}}} A message without an instance specified will default to the instance “personal”. @@ -114,7 +120,9 @@ There are many other acronyms that are used; if you don't know what it means, tr There might be some options that you want to be consistent from session to session; you don't want to have to set the same variables each time. You can fix this by adding the commands to your "startup" file, for example, {{{.owl/startup}}}. This can be done from within Barnowl, by using the {{{startup}}} command: -{{{:startup set foo bar}}} +{{{ +:startup set foo bar +}}} Where {{{foo}}} is the variable you want to set, and {{{bar}}} is the value. You do not necessarily have to use the {{{set}}} command, either, any command you can type in Barnowl can be added to the startup file. @@ -122,13 +130,17 @@ Where {{{foo}}} is the variable you want to set, and {{{bar}}} is the value. Yo It is handy to be able to log your conversations so you can refer back to them later. To log classes, for example: -{{{set classlogging on}}} -{{{set classlogpath ~/Private/zlog/class}}} +{{{ +:set classlogging on +"set classlogpath ~/path/to/class/log +}}} And to log personals: -{{{set logging on}}} -{{{set logpath ~/Private/zlog/people}}} +{{{ +:set logging on +:set logpath ~/path/to/people/log +}}} === Colors === @@ -140,9 +152,19 @@ Colors may vary from machine to machine, as different terminal profiles may have Some people like to customize their Barnowl by color-coding classes. This makes it easier to tell different classes apart (and minimize mixing). Barnowl has some already existing filters, for example, {{{personal}}} (for incoming personals), {{{out}}} (for outgoing personals), and {{{ping}}} (for pings). To assign a color to a filter, add the following to your startup file: -{{{filter personal -c green}}} +{{{ +filter personal -c green +}}} What if you want to color-code your class, or a friends class? You can create and color filters with: -{{{filter johndoe class johndoe}}} -{{{filter johndoe -c blue}}} \ No newline at end of file +{{{ +filter johndoe class johndoe +filter johndoe -c blue +}}} + +You can update your settings and filters without restarting your Barnowl session by: + +{{{ +:source ~/path/to/config/file +}}} \ No newline at end of file