From c342c299af286083a60e447f3f4cbdc84f5cfbfa Mon Sep 17 00:00:00 2001 From: onefang Date: Thu, 29 Aug 2019 13:14:13 +1000 Subject: Docs++ --- doc/scripts.html | 113 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 113 insertions(+) (limited to 'doc/scripts.html') 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 @@ +

There are various scripts included, mostly Bash shell scripts.

+ +

opensim-SC/BuildIt.sh

This script will compile, or recompile the entire system.

+ +

opensim-SC/InstallItAll.sh

+ +

Installs everything on a Debian like operating system. You will need +to know your root/sudo password and your MariaDB root password, though if +MariaDB isn't installed, it will be installed. Note that some recent +versions of MariaDB want to be passwordless for root.

+ +

opensim-SC/TestIt.sh

Runs unit tests on opensim-SC.

opensim-SC/nant-color

Obsolete since Debian removed nant, but used to be part of the build system.

opensim-SC/runprebuild.bat and opensim-SC/runprebuild.sh

Parts of the build system.

opensim-SC/example/start.sh

An example script that runs a specific sim.

opensim-SC/scripts/backup-grid.sh

Backup the entire grid into gitAR archive files, which are like IAR and OAR files, only with git info in them, and compressed better.

opensim-SC/scripts/backup-inventories.sh

Backup inventories of anyone that has logged on in since the last time this was run.

opensim-SC/scripts/backup-inventory

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.

opensim-SC/scripts/backup-sims.sh

Backup all currently running sims.

opensim-SC/scripts/common.sh

Common data and functions for the other scripts.

opensim-SC/scripts/fix_some_assets.pl

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.

opensim-SC/scripts/gitAR.sh

Script for dealing with gitARs, though not meant to be used by users.

opensim-SC/scripts/show-console

Show the tmux consoles.

+ +

opensim-SC/scripts/start-sim

+ +

Start / stop sims, backup inventories / sims. This script does +different things depending on where it is called from, and the name it is +called as. It has afew options you can pass to it on the command line.

+ +

-a - Used internally as part of the "start up everything" mentioned below.
-d X - Define a delay to wait between sims when starting up everything, the default is 60 seconds.
-q - Don't show the tmux console os start up.
-w - Wait until the "INITIALIZATION COMPLETE FOR " line shows in the console before continuing.

+ +

Called as backup-inventory

Backs up the inventory of the user specified in the arguments to an .iar file and updates the _gitIAR.tar.xz file.

+ +

   ./backup-inventory Avatar Name

+ +

Called as backup-sim from config/simXX

Backs up the sim to an .oar and updates the _gitOAR.tar.xz file.

+ +

Called as start-sim from config/ROBUST

Starts up ROBUST if it is called from the config directory holding the ROBUST configuration.

+ +

Called as start-sim from config/simXX

Starts up the sim if it is called from the config directory holding the sim configuration.

+ +

Called as start-sim from opensim-SC/scripts

Will start up everything.

+ +

Called as start-sim from opensim-SC/bin

Used internally by the "start up everything" process to start up the sims. It assumes that ROBUST was recently started.

+ +

Called as stop-sim from config/ROBUST

Stops ROBUST if it is called from the config director holding the ROBUST configuration.

+ +

Called as stop-sim from config/simXX

Stops the sim if it is called from the config director holding the sim +configuration. It gives users on the sim a couple of warnings, waits a +while, then shuts down the sim.

+ +

opensim-SC/scripts/install/create_sim.sh

Create a sim. Ther are several optional arguments. If an argument is missing or blank, a default is used.

+ +

"sim name" - The name of the sime you want, the default is "No name sim XXX" where XXX is a random number.
1234,1234 - The map location of the sim, the default is some random location.
256 - The size of the sim, the default is 256 x 256 meters.

+ +

   ./create_sim "My Dobule Sized Sim", 1234,1234 512

+ +

opensim-SC/scripts/install/go_live.sh

+ +

Installs the monit config files. Note that a recent version of Monit +seems to have issue with this, that I haven't tracked down yet. Monit +isn't needed most of the time, and I want to replace it with something +internal in the next major release.

+ +

opensim-SC/scripts/install/group_migrate.sql

An obsolete SQL script for migrating to OS groups.

opensim-SC/scripts/install/opensim-monit.conf

The template monit config file.

+ +

opensim-SC/scripts/install/opensim.tmux.conf

+ +

The tmux config file. Note that tmux has a tendency to change how +their config files work from one version to the next. It would be wise +to test this before trying to use it.

+ +

opensim-SC/scripts/install/secure.sh

+ +

Script to properly set ownership and permissions for files and +directories in opensim-SC. Once you have a lot of assets, this wil take +along time. It is called from InstallItAll.sh

-- cgit v1.1