aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc/scripts.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/scripts.html')
-rw-r--r--doc/scripts.html113
1 files changed, 113 insertions, 0 deletions
diff --git a/doc/scripts.html b/doc/scripts.html
index 55b8d26..8551a79 100644
--- a/doc/scripts.html
+++ b/doc/scripts.html
@@ -3,6 +3,119 @@
3<head> 3<head>
4</head> 4</head>
5<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple"> 5<body bgcolor="black" text="white" alink="red" link="blue" vlink="purple">
6<p>There are various scripts included, mostly Bash shell scripts.</p>
7
8<h1>opensim-SC/BuildIt.sh</h1>
9<p>This script will compile, or recompile the entire system.</p>
10
11<h1>opensim-SC/InstallItAll.sh</h1>
12
13<p>Installs everything on a Debian like operating system. You will need
14to know your root/sudo password and your MariaDB root password, though if
15MariaDB isn't installed, it will be installed. Note that some recent
16versions of MariaDB want to be passwordless for root.</p>
17
18<h1>opensim-SC/TestIt.sh</h1>
19<p>Runs unit tests on opensim-SC.</p>
20<h1>opensim-SC/nant-color</h1>
21<p>Obsolete since Debian removed nant, but used to be part of the build system.</p>
22<h1>opensim-SC/runprebuild.bat and opensim-SC/runprebuild.sh</h1>
23<p>Parts of the build system.</p>
24<h1>opensim-SC/example/start.sh</h1>
25<p>An example script that runs a specific sim.</p>
26<h1>opensim-SC/scripts/backup-grid.sh</h1>
27<p>Backup the entire grid into gitAR archive files, which are like IAR and OAR files, only with git info in them, and compressed better.</p>
28<h1>opensim-SC/scripts/backup-inventories.sh</h1>
29<p>Backup inventories of anyone that has logged on in since the last time this was run.</p>
30<h1>opensim-SC/scripts/backup-inventory</h1>
31<p>Backup a single accounts inventory. It's a symlink to start-sim, which figures out what to do based on the name it is called as.</p>
32<h1>opensim-SC/scripts/backup-sims.sh</h1>
33<p>Backup all currently running sims.</p>
34<h1>opensim-SC/scripts/common.sh</h1>
35<p>Common data and functions for the other scripts.</p>
36<h1>opensim-SC/scripts/fix_some_assets.pl</h1>
37<p>An old script to fix some problems caused by a bug in OpenSim. Not sure it's needed anymore, or even if it'll work. Probably best to not use it.</p>
38<h1>opensim-SC/scripts/gitAR.sh</h1>
39<p>Script for dealing with gitARs, though not meant to be used by users.</p>
40<h1>opensim-SC/scripts/show-console</h1>
41<p>Show the tmux consoles.</p>
42
43<h1>opensim-SC/scripts/start-sim</h1>
44
45<p>Start / stop sims, backup inventories / sims. This script does
46different things depending on where it is called from, and the name it is
47called as. It has afew options you can pass to it on the command line.</p>
48
49<ul>
50<li>-a - Used internally as part of the "start up everything" mentioned below.</li>
51<li>-d X - Define a delay to wait between sims when starting up everything, the default is 60 seconds.</li>
52<li>-q - Don't show the tmux console os start up.</li>
53<li>-w - Wait until the "INITIALIZATION COMPLETE FOR " line shows in the console before continuing.</li>
54</ul>
55
56<h2>Called as backup-inventory</h2>
57<p>Backs up the inventory of the user specified in the arguments to an .iar file and updates the _gitIAR.tar.xz file.</p>
58
59<pre>&nbsp; &nbsp;./backup-inventory Avatar Name</pre>
60
61<h2>Called as backup-sim from config/simXX</h2>
62<p>Backs up the sim to an .oar and updates the _gitOAR.tar.xz file.</p>
63
64<h2>Called as start-sim from config/ROBUST</h2>
65<p>Starts up ROBUST if it is called from the config directory holding the ROBUST configuration.</p>
66
67<h2>Called as start-sim from config/simXX</h2>
68<p>Starts up the sim if it is called from the config directory holding the sim configuration.</p>
69
70<h2>Called as start-sim from opensim-SC/scripts</h2>
71<p>Will start up everything.</p>
72
73<h2>Called as start-sim from opensim-SC/bin</h2>
74<p>Used internally by the "start up everything" process to start up the sims. It assumes that ROBUST was recently started.</p>
75
76<h2>Called as stop-sim from config/ROBUST</h2>
77<p>Stops ROBUST if it is called from the config director holding the ROBUST configuration.</p>
78
79<h2>Called as stop-sim from config/simXX</h2>
80<p>Stops the sim if it is called from the config director holding the sim
81configuration. It gives users on the sim a couple of warnings, waits a
82while, then shuts down the sim.</p>
83
84<h1>opensim-SC/scripts/install/create_sim.sh</h1>
85<p>Create a sim. Ther are several optional arguments. If an argument is missing or blank, a default is used.</p>
86
87<ul>
88<li>"sim name" - The name of the sime you want, the default is "No name sim XXX" where XXX is a random number.</li>
89<li>1234,1234 - The map location of the sim, the default is some random location.</li>
90<li>256 - The size of the sim, the default is 256 x 256 meters.</li>
91</ul>
92
93<pre>&nbsp; &nbsp;./create_sim "My Dobule Sized Sim", 1234,1234 512</pre>
94
95<h1>opensim-SC/scripts/install/go_live.sh</h1>
96
97<p>Installs the monit config files. Note that a recent version of Monit
98seems to have issue with this, that I haven't tracked down yet. Monit
99isn't needed most of the time, and I want to replace it with something
100internal in the next major release.</p>
101
102<h1>opensim-SC/scripts/install/group_migrate.sql</h1>
103<p>An obsolete SQL script for migrating to OS groups.</p>
104<h1>opensim-SC/scripts/install/opensim-monit.conf</h1>
105<p>The template monit config file.</p>
106
107<h1>opensim-SC/scripts/install/opensim.tmux.conf</h1>
108
109<p>The tmux config file. Note that tmux has a tendency to change how
110their config files work from one version to the next. It would be wise
111to test this before trying to use it.</p>
112
113<h1>opensim-SC/scripts/install/secure.sh</h1>
114
115<p>Script to properly set ownership and permissions for files and
116directories in opensim-SC. Once you have a lot of assets, this wil take
117along time. It is called from InstallItAll.sh</p>
118
6<p>&nbsp;</p> 119<p>&nbsp;</p>
7</body> 120</body>
8</html> 121</html>
generated by cgit v1.1 at 2024-06-17 03:30:00 +0000