X-Git-Url: http://scm.dxcluster.org/gitweb/gitweb.cgi?a=blobdiff_plain;f=sgml%2Fadminmanual.sgml;h=5fd568c2ef9776974060e893f9b4e33be2cab08e;hb=1d232a6bb3361c58a80a7ec7cf379358863b1c21;hp=18ec844986eb86cb379b5d3061427e3faeb787f4;hpb=8e862ce4b386889bc91c34ec788df0bd1a062c6c;p=spider.git diff --git a/sgml/adminmanual.sgml b/sgml/adminmanual.sgml index 18ec8449..5fd568c2 100644 --- a/sgml/adminmanual.sgml +++ b/sgml/adminmanual.sgml @@ -5,8 +5,8 @@
-You will find a file in /spider/cmd/ called Aliases. First, copy this file to
-/spider/local_cmd/Aliases and edit this file. You will see something like this ...
+You will find a file in /spider/cmd/ called Aliases. This is the file that
+controls what a user gets when issuing a command. It is also possible to
+create your own aliases for databases and files you create locally.
-
+You should not alter the original file in /spider/cmd/ but create a new file
+with the same name in /spider/local_cmd. This means that any new Aliases files
+that is downloaded will not overwrite your self created Aliases and also that
+you do not override any new Aliases with your copy in /spider/local_cmd/. You
+must remember that any files you store in /spider/local/ or /spider/local_cmd
+override the originals if the same lines are used in both files.
-# You only need to put aliases in here for commands that don't work as
-# you desire naturally, e.g sh/dx on its own just works as you expect
-# so you need not add it as an alias.
+
+The best way of dealing with all this then is to only put your own locally
+created Aliases in the copy in /spider/local_cmd. The example below is
+currently in use at GB7MBC.
+
-You can create aliases for commands at will. Beware though, these may not
-always turn out as you think. Care is needed and you need to test the
-results once you have set an alias.
+Each alphabetical section should be preceded by the initial letter and the section
+should be wrapped in square brackets as you can see. The syntax is straightforward.
+The first section on each line is the new command that will be allowed once the
+alias is included. The second section is the command it is replacing and the last
+section is the actual command that is being used.
+
+
+The eagle-eyed amongst you will have noticed that in the first section, the new
+alias command has a '^' at the start and a '$' at the end. Basically these force
+a perfect match on the alias. The '^' says match the beginning exactly and the
+'$' says match the end exactly. This prevents unwanted and unintentional matches
+with similar commands.
+
+
+I have 3 different types of alias in this file. At the top is an alias for 'news'.
+This is a file I have created in the /spider/packclus/ directory where I can inform
+users of new developments or points of interest. In it's initial form a user would
+have to use the command type news. The alias allows them to simply type
+news to get the info. Second is an alias for the show/qrz
+command so that those users used to the original show/buck command in
+AK1A will not get an error, and the rest of the lines are for locally created
+databases so that a user can type show/hftest instead of having to use
+the command dbshow hftest which is not as intuitive.
+
+
+This file is just an example and you should edit it to your own requirements.
+Once created, simply issue the command load/alias at the cluster
+prompt as the sysop user and the aliases should be available.
+