1Last revised: Dec 30, 2017
2
3Filesys Module
4
5This module provides an area within the bot where users can store and
6manage files. With this module, the bot is usable as a file server.
7
8This module requires: transfer
9
10CONFIG FILE SETUP
11
12Put this line into your Eggdrop configuration file to load the filesys
13module:
14
15    loadmodule filesys
16
17There are also some variables you can set in your config file:
18
19  set files-path "/home/mydir/eggdrop/filesys"
20
21      Set here the 'root' directory for the file system.
22
23  set incoming-path "/home/mydir/eggdrop/filesys/incoming"
24
25      If you want to allow uploads, set this to the directory uploads
26      should be put into. Set this to "" if you don't want people to
27      upload files to your bot.
28
29  set upload-to-pwd 0
30
31      If you don't want to have a central incoming directory, but
32      instead want uploads to go to the current directory that a user is
33      in, set this setting to 1.
34
35  set filedb-path ""
36
37      Eggdrop creates a '.filedb' file in each subdirectory of your file
38      area to keep track of its own file system information. If you
39      can't do that (for example, if the dcc path isn't owned by you, or
40      you just don't want it to do that) specify a path here where you'd
41      like all of the database files to be stored instead.
42
43  set max-file-users 20
44
45      Set here the maximum number of people that can be in the file area
46      at once. Setting this to 0 makes it effectively infinite.
47
48  set max-filesize 1024
49
50      Set here the maximum allowable file size that will be received (in
51      KB). Setting this to 0 makes it effectively infinite.
52
53PARTYLINE USAGE
54
55.files
56
57  Moves you into the file transfer sub-system, if it has been enabled on
58  this bot. From there you can browse through the files online and use
59  dcc file transfers to download and upload.
60
61.cancel <file> [file] ...
62
63  Tells the bot to stop sending a file that is pending (either queued,
64  waiting, or in the process of being transferred).
65
66.cd <directory>
67
68  Changes your current directory if possible. this works exactly like
69  the unix command.
70
71.cp <source> <dst>
72
73  Copies a file or group of files from one place to another.
74
75.desc <file> <description>
76
77  Changes the description for a file. if you are a master or file
78  janitor, you can change the description for any file. otherwise you
79  can only change the descriptions for files you have uploaded.
80
81  The description is restricted to 3 lines of 60 characters each, and is
82  broken up between words. you can force a line break by putting a '|'
83  in the comment.
84
85.filestats <user> [clear]
86
87  Reports on the users upload & download statistics. Optional argument
88  'clear' clears a users upload and download statistics.
89
90.stats
91
92  Clears a users upload & download statistics.
93
94.get <filename> [nickname]
95
96  Sends you the file(s) requested, over IRC. you should get a DCC SEND
97  notice on IRC, and have your client accept it. if your nickname on IRC
98  is different than the one you use on the bot, you should specify a
99  nickname too. you can also use that to send files to other people. if
100  a file you want is actually on another bot, it may take a little bit
101  longer so be patient. if that bot isn't on the botnet right now, it
102  will say the file isn't available.
103
104  There is a limit to the number of transfers you can have going
105  simultaneously, so if you go over this limit, the remainder of your
106  file requests will be queued. As the first files finish transferring,
107  the queued files will be sent.
108
109.hide <file> [files] ...
110
111  Marks a file as hidden, so that normal users can't see it. Only a
112  master or file janitor using %b'lsa'%b can see hidden files.
113
114.ln <bot:filepath> <localfile>
115
116  Creates a link to a file on another bot. The filepath has to be
117  complete, like '/gifs/uglyman.gif'. If the bot is not connected to the
118  botnet, nobody will be able to download the file until that bot
119  connects again. The local filename can be anything you want.
120
121  Example: ln Snowbot:/gifs/uglyman.gif ugly.gif
122
123.ls [filemask]
124
125  Displays the files in the current directory. Subdirectories are shown
126  with "<DIR>" next to them, and other files will display their size
127  (typically in kilobytes), who uploaded them (and when), and how many
128  times each file has been downloaded. If a description of the file
129  exists, it is displayed below the filename. You can restrict the file
130  listing by specifying a mask, just like in unix.
131
132.mkdir <dir> [flags [channel]]
133
134  Creates a subdirectory from this one, with the given name. If flags
135  are specified, then those flags are required to enter or even see the
136  directory. You can even specify a channel that the flags are matched
137  against. You can use the %b'mkdir'%b command again to alter or remove
138  those flags.
139
140.mv <source> <dest>
141
142  Moves a file or group of files from one place to another (it can also
143  be used to rename files).
144
145.pending
146
147  Gives you a listing of every file you've requested which is still
148  waiting, queued, or in the process of transferring. It shows you the
149  nickname on IRC that the file is being sent to, and, if the transfer
150  is in progress, tells you how far along the transfer is.
151
152.pwd
153
154  Tells you what your current directory is.
155
156.quit
157
158  Exits the file system.
159
160rm <file> [files] ...
161
162  Erase a file for good.
163
164.rmdir <dir>
165
166  Removes an existing directory, if there are no files in it.
167
168.share <file> [files] ...
169
170  Marks a file as shared. This means that other bots can get the file
171  remotely for users on their file systems. By default, files are marked
172  as unshared.
173
174.optimize
175
176  Cleans up the current directory's database. If you have a large
177  directory with many files you may want to use this command if you
178  experience slow-downs/delays over time. Normally, the db should clean
179  up itsself though.
180
181.unhide
182
183  Makes a file be not hidden any more.
184
185.unshare <file> [file] ...
186
187  Removes the shared tag from a file.
188
189.filesys module
190
191  This module provides an area within the bot where users can store and
192  manage files. With this module, the bot is usable as a file server.
193
194  The following commands are provided by the filesys module:
195
196  For filesystem users:
197
198      files
199
200Copyright (C) 2000 - 2021 Eggheads Development Team
201