~ubuntu-branches/ubuntu/lucid/eggdrop/lucid

« back to all changes in this revision

Viewing changes to src/mod/share.mod/help/share.help

  • Committer: Bazaar Package Importer
  • Author(s): Guilherme de S. Pastore
  • Date: 2004-06-17 09:15:28 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040617091528-64rrw1sa33lkfhmh
Tags: 1.6.16-2
* Fixed typo on README.Debian
* Fixed hyphens in manual page
* Converted debian/rules to CDBS
* Set path to binary on example config file
* Changed LANGDIR on src/eggdrop.h (Closes: #254824)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
%{help=share howto}%{+n}
 
2
###  %bshare howto%b
 
3
   First you need to decide two things:
 
4
     %b1.%b Which bot will be 'active' and which 'passive'.
 
5
        The active bot will SEND a userfile to the passive bot. %bThe passive%b
 
6
        %bbot's userfile will be overwritten.%b We shall call the %bACTIVE%b bot
 
7
        "A", and the %bPASSIVE%b bot B.
 
8
 
 
9
     %b2.%b Which channels you want to share between the 2 bots. ALL global
 
10
        info will be shared, but only the channels you mark as shared will be
 
11
        shared.
 
12
 
 
13
   Steps:
 
14
     %b1.%b For each channel you want to share, do:
 
15
 
 
16
           .chanset #channel +shared
 
17
 
 
18
     %b2.%b On bot A, type:
 
19
     
 
20
           '.botattr B +s' (+s means actively share)
 
21
 
 
22
     %b3.%b On bot B, type:
 
23
 
 
24
           '.botattr A +p' (+s means passively share)
 
25
 
 
26
     %b4.%b For each channel you want shared between the two, do the following:
 
27
 
 
28
           On bot A, type: '.botattr B |+s #channel'
 
29
           On bot B, type: '.botattr A |+s #channel'
 
30
 
 
31
     %b5.%b Link them together; they should start sharing immediately.
1
32
%{help=flush}%{+n}
2
33
###  %bflush%b <bot>
3
 
   clears the resync buffer for a share-bot.  this is useful if you
4
 
   want to start over with a userfile transfer: you can unlink the
5
 
   sharebots, flush the resync buffer, and relink.
6
 
   
7
 
see also: link, chattr, unlink
8
 
%{help=set allow-resync}%{+n}
9
 
###  %bset allow-resync%b 0/1
10
 
   This setting determines if the bot will re-send the userfile every
11
 
   single time a sharebot reconnects, or if it will store changes
12
 
   that occur for %bresync-time%b seconds and send only these when
13
 
   the sharebot reconnects, this has been know to be a bit unreliable
14
 
   in the past, hence the option.
15
 
   
16
 
see also: set resync-time
17
 
%{help=set resync-time}%{+n}
18
 
###  %bset resync-time%b <#>
19
 
   This sets the number of seconds to store resync information for
20
 
   a sharebot before it's assumed to be dead & buried, and therefore
21
 
   the userfile needs to be re-sent.
22
 
   
23
 
see also: set allow-resync
24
 
%{help=set private-global}%{+n}
25
 
###  %bset private-global%b 0/1
26
 
   If you are sharing userfiles with someone else, and you don't
27
 
   want %bany%b global flags on the other bots propagated to your bot, 
28
 
   set this.  It overrides the setting of private-globals.
29
 
   
30
 
see also: set private-globals
31
 
%{help=set private-globals}%{+n}
32
 
###  %bset private-globals%b [flags]
33
 
   If you are sharing userfiles with someone else, and you don't
34
 
   want various global flags on the other bots propagated to your bot, 
35
 
   set this to the global flags you would like to remain unaffected.
36
 
   The setting of private-global will override this.   
37
 
   
38
 
see also: set private-global
 
34
   This clears the resync buffer for a share-bot. This is useful if you want
 
35
   to start over with a userfile transfer. You can unlink the sharebots, flush
 
36
   the resync buffer, and relink.
 
37
 
 
38
See also: link, unlink, chattr, botattr
39
39
%{help=share module}%{+n}
40
 
###  help on the %bshare module%b
41
 
   This module provides userfile sharing between two bots, it
42
 
   transfers the userfile when they first connect, and then
43
 
   send updates whilst they are connected to keep the userfiles
44
 
   in sync.
45
 
   Commands available: %bflush%b
46
 
   Tcl settings      : %ballow-resync%b  %bresync-time%b
47
 
                       %bprivate-global%b %bprivate-globals%b
48
 
   see %b'.help share howto'%b for a step-by-step list of what
49
 
   needs to be done to setup sharing.
50
 
%{help=share howto}%{+n}
51
 
###   how to setup sharing with the %bshare module%b
52
 
   First you need to decide 2 things:
53
 
     (1) which bot will be 'active' and which 'passive',
54
 
         the passive bot's userfile WILL GET OVERWRITTEN
55
 
         so choose carefully.
56
 
         We shall call the ACTIVE bot A, the PASSIVE bot B
57
 
     (2) which channels you want to share between the 2 bots.
58
 
         Only the channels you choose to share will have their
59
 
         info shared, ALL global info will be shared.
60
 
         
61
 
   Steps:
62
 
     (1) Do for each of the channels you want to share a
63
 
         .chanset #channel +shared
64
 
     (2) on A type: '.botattr B +s'   +s == actively share
65
 
         on B type: '.botattr A +p'   +p == passively share
66
 
     (3) for each channel you want shared between the two,
67
 
           on A type: '.botattr B |+s #channel'
68
 
           on B type: '.botattr A |+s #channel'
69
 
     (4) link them together, they should start sharing immediately         
 
40
###  %bshare module%b
 
41
   This module provides userfile sharing support between two directly linked
 
42
   bots.
 
43
 
 
44
   See %b'.help share howto'%b for more information.
 
45
 
 
46
   The following commands are provided by the share module:
 
47
 
 
48
   For global owners:
 
49
      %bflush%b
 
50
 
 
51
   Config file variables for configuring the share module:
 
52
      %ballow-resync    resync-time         private-global%b
 
53
      %bprivate-user    override-bots       private-globals%b
 
54
   (Use %b'.help set <variable>'%b for more info)
70
55
%{help=all}%{+n}
71
 
###  commands for the %bshare module%b
72
 
  %bflush%b
 
56
###  %bshare module%b commands
 
57
   For global owners:
 
58
      %bflush%b