Syrex provides both pro-active and ad-hoc support on hardware, software and network infrastructure. Please contact us for assistance. The following reference tools and material are hopefully helpful

Cabling

The following technical wiring specifications have been compiled and tested by Syrex Intranets. This information is primarily usefull to support engineers, and IT professionals, that are wanting to construct or check certain network or cable configurations.

 10Base-T wiring

10Base-T wiring CAT 3 wire pairing

The pinouts are for RJ45 8pin sockets. The terminology T and R comes from the old telecom days of ‘Tip’ and ‘Ring’ of jack plugs and corrosponds to the +ve and -ve on the twisted pair of cables and notTransmit and Receive of ethernet data!

colour stripe = Tip = +ve ; solid colour = Ring = -ve

Old CAT3 10Base-T only needs two pairs of would often be shown wired using pairs #1 and #2. It is however alternatively also shown to be wired using just pairs #2 and #3 as a subset of the more modern EIA568B (again all electrically compatible – just pair number and colour codes changed).

 UTP Network wiring (up to 10Gbps)

100Base-TX wiring CAT 5 wire pairing

The pinouts are for RJ45 8pin sockets. The terminology T and R comes from the old telecom days of ‘Tip’ and ‘Ring’ of jack plugs and corrosponds to the +ve and -ve on the twisted pair of cables and notTransmit and Receive of ethernet data!

colour stripe = Tip = +ve ; solid colour = Ring = -ve

The CAT5 sockets (ModTap) supplied by RS are generally colour coded to the EIA568B standard (which was the old AT&T 258A standard).

 UTP Crossover wiring (up to 10Gbps)

10Base-T and 100Base-TX crossover wiring 10Base-T and 100Base-TX crossover wiring CAT 5 wire pairing

The pinouts are for RJ45 8pin sockets. The terminology T and R comes from the old telecom days of ‘Tip’ and ‘Ring’ of jack plugs and corrosponds to the +ve and -ve on the twisted pair of cables and notTransmit and Receive of ethernet data!

colour stripe = Tip = +ve ; solid colour = Ring = -ve

The CAT5 sockets (ModTap) supplied by RS are generally colour coded to the EIA568B standard (which was the old AT&T 258A standard). In crossover cabling T1 connects to R4, T2 to R3, T3 to R2 and T4 to R1.

 ISDN wiring

ISDN wiring CAT 5 wire pairing

The pinouts are for RJ45 8pin sockets. The terminology T and R comes from the old telecom days of ‘Tip’ and ‘Ring’ of jack plugs and corrosponds to the +ve and -ve on the twisted pair of cables and notTransmit and Receive of ethernet data!

colour stripe = Tip = +ve ; solid colour = Ring = -ve

The CAT5 sockets (ModTap) supplied by RS are generally colour coded to the EIA568B standard (which was the old AT&T 258A standard). ISDN is generally wired to the EIA568A (100Base-TX) standard. This is electrically compatible to EIA568B but the pair and color codes of 2 and 3 are swapped around.

 USOC 4, 6 & 8 (Token ring) wiring

USOC 4, 6 & 8 (Token ring) wiring USOC 4, 6 & 8 wire pairing

The pinouts are for RJ45 8pin sockets. The terminology T and R comes from the old telecom days of ‘Tip’ and ‘Ring’ of jack plugs and corrosponds to the +ve and -ve on the twisted pair of cables and notTransmit and Receive of ethernet data!

colour stripe = Tip = +ve ; solid colour = Ring = -ve

USOC 4, 6 & 8 or more commonly known as Token ring wiring

 Null Modem wiring

One connector is assembled from each side of the hyphens. The frame ground on the 25 pin plug is optional and should only be connected on one side of the cable.

If you need DCD (Data Carrier Detect) on your cable (BBS programs, Unix Getty and so on) then see below. The connections for DCD should be made on the same end of the cable.

  • On a 25 pin plug connect pin 6 and 8.
  • On a 9 pin plug connect pin 1 and 6.

Pin Connections:

25 Pin 9 Pin 9 Pin 25 Pin
FG (Frame Ground) 1 X 1 FG (Frame Ground)
TD (Transmit Data) 2 3 2 3 RD (Receive Data)
RD (Receive Data) 3 2 3 2 TD (Transmit Data)
RTS (Request To Send) 4 7 8 5 CTS (Clear To Send)
CTS (Clear To Send) 5 8 7 4 RTS (Request To Send)
SG (Signal Ground) 7 5 5 7 SG (Signal Ground)
DSR (Data Set Ready) 6&8 6&1 4 20 DTR (Data Terminal Ready)
DTR (Data Terminal Ready) 20 4 6&1 6&8 DSR (Data Set Ready)
Where to find Pin 1:

Female Male
25 pin (DB25) 25 pin Female (DB25) 25 pin Male (DB25)
9 pin (DB9) 9 pin Female (DB9) 9 pin Male (DB9)
 Laplink cable wiring

One connector is assembled from each side of the hyphens. This is the wiring diagram for the cable necessary to link two machines together by their parallel ports for a LapLink connection. You can also use such a cable in combination with the PLIP packet driver to simulate an Ethernet running on two machines. FastLynx is another program that enables communication between PCs via a parallel cable.

  • Cable pin connections used on both types of cables.
  • Laplink/Interlink cable pin connections.
  • FastLynx 2.0 cable pin connections.

Pin Connections:

25 Pin 25 Pin
Strobe 1 1/7 Strobe/Data bit 5
Data bit 0 2 15 Error
Data bit 1 3 13 Select
Data bit 2 4 12 Paper out
Data bit 3 5 10 Ackn.
Data bit 4 6 11 Busy
Data bit 5 7 1 Strobe
Data bit 6 8 14 Autofeed
Data bit 7 9 16 Initialize
Ackn. 10 5 Data bit 3
Busy 11 6 Data bit 4
Paper out 12 4 Data bit 2
Select 13 3 Data bit 1
Autofeed 14 14/8 Autofeed/Data bit 6
Error 15 2 Data bit 0
Initialize 16 16/9 Initialize/Data bit 7
Select Input 17 17 Select Input
Ground 18 18 Ground
Ground 25 25 Ground
Where to find Pin 1:

Female Male
25 pin (DB25) 25 pin Female (DB25) 25 pin Male (DB25)
 3Com Palm III Cradle to Modem Cable

One connector is assembled from each side of the hyphens.

Pin Connections:

9 Pin Male 25 Pin Male
DSR (Data Set Ready) 6 20 DTR (Data Terminal Ready)
TD (Transmit Data) 3 3 RD (Receive Data)
CTS (Clear To Send) 8 4 RTS (Request To Send)
RD (Receive Data) 2 2 TD (Transmit Data)
RTS (Request To Send) 7 5 CTS (Clear To Send)
SG (Signal Ground) 5 7 SG (Signal Ground)
Where to find Pin 1:

Female Male
25 pin (DB25) 25 pin Female (DB25) 25 pin Male (DB25)
9 pin (DB9) 9 pin Female (DB9) 9 pin Male (DB9)
 PS/2 Mouse & Keyboard connections

Pin Connections:

Pin Signal
1 Data
2 Not used
3 Ground
4 +5V DC
5 Clock
6 Not used
Where to find Pin 1:

Female Male
6 pin (PS/2) PS/2 Female PS/2 Male

CGI Environment Variable Lister

CGI (Common Gateway Interface) applications are programs run by web servers. CGI applications obtain information from clients, or the web server running the application, by evaluating various environment variables. The information presented here is primarily usefull to CGI application developers or support engineers.

Environment variables passed along with this request:

SCRIPT_NAME: /cgi-bin/debug.cgi
SERVER_NAME: www.syrex.co.za
HTTP_REFERER: https://www.syrex.co.za/tools-page/
SERVER_ADMIN: rootmail@syrex.co.za
HTTP_ACCEPT_ENCODING: gzip, deflate
HTTP_CONNECTION: keep-alive
REQUEST_METHOD: GET
HTTP_ACCEPT: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3
SCRIPT_FILENAME: /var/www/www.syrex.co.za/cgi-bin/debug.cgi
SERVER_SOFTWARE: Apache
QUERY_STRING: 
REMOTE_PORT: 51584
HTTP_USER_AGENT: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36
SERVER_PORT: 80
SERVER_SIGNATURE: 
HTTP_UPGRADE_INSECURE_REQUESTS: 1
HTTP_ACCEPT_LANGUAGE: en-US,en;q=0.9
HTTP_COOKIE: _ga=GA1.3.1275484097.1562224328; _gid=GA1.3.68309328.1562740780
REMOTE_ADDR: 154.117.128.90
SERVER_PROTOCOL: HTTP/1.1
PATH: /sbin:/usr/sbin:/bin:/usr/bin:/usr/X11R6/bin
REQUEST_URI: /cgi-bin/debug.cgi
GATEWAY_INTERFACE: CGI/1.1
SERVER_ADDR: 41.79.20.2
DOCUMENT_ROOT: /var/www/www.syrex.co.za
HTTP_HOST: www.syrex.co.za

 24 Hour Perl Tutorial: Start


This is the start of a tutorial on Perl, originally run by me, Nik Silver, as the first part of a one-day hands-on workshop at the School of Computer Studies, University of Leeds, in the UK. The second part of the workshop looked at designing pages for the World Wide Web using Perl to deal with buttons and text boxes to generate custom Web pages on the fly.

There are plenty of other Perl tutorials around, and most (if not all) of them can be found at the UF/NA Perl Archive. However I wanted something that included exercises developing a consistent theme; none of the others seemed to do this.

This tutorial assumes a very basic knowledge of UNIX and concentrates on how to write basic working perl programs. It does not explain why many things are as they are, nor does it draw generalisations about the language; it is assumed that the reader can make most of these inferences correctly for themselves. You can find more information on those topics elsewhere (see above).

The structure of this tutorial is as follows:


 Perl Tutorial: A basic program

 

Here is the basic perl program that we’ll use to get started.

#!/usr/local/bin/perl
#
# Program to do the obvious
#
print 'Hello world.';		# Print a message

Each of the parts will be discussed in turn.


The first line

Every perl program starts off with this as its very first line:

#!/usr/local/bin/perl

although this may vary from system to system. This line tells the machine what to do with the file when it is executed (ie it tells it to run the file through Perl).


Comments and statements

Comments can be inserted into a program with the # symbol, and anything from the # to the end of the line is ignored (with the exception of the first line). The only way to stretch comments over several lines is to use a # on each line.

Everything else is a Perl statement which must end with a semicolon, like the last line above.


Simple printing

The print function outputs some information. In the above case it prints out the the literal string Hello world. and of course the statement ends with a semicolon.

You may find the above program produces an slightly unexpected result. So the next thing to do is to run it.


 Running the program


Type in the example program using a text editor, and save it. Emacs is a good editor to use for this because it has its own Perl mode which formats lines nicely when you hit tab (use `M-x perl-mode’). But as ever, use whichever you’re most comfortable with.

After you’ve entered and saved the program make sure the file is executable by using the command

chmod u+x progname

at the UNIX prompt, where progname is the filename of the program. Now to run the program just type any of the following at the prompt.

perl progname
./progname
progname

If something goes wrong then you may get error messages, or you may get nothing. You can always run the program with warnings using the command

perl -w progname

at the prompt. This will display warnings and other (hopefully) helpful messages before it tries to execute the program. To run the program with a debugger use the command

perl -d progname

When the file is executed Perl first compiles it and then executes that compiled version. So after a short pause for compilation the program should run quite quickly. This also explains why you can get compilation errors when you execute a Perl file which consists only of text.

Make sure your program works before proceeding. The program’s output may be slightly unexpected – at least it isn’t very pretty. We’ll look next at variables and then tie this in with prettier printing.


 Scalar variables


The most basic kind of variable in Perl is the scalar variable. Scalar variables hold both strings and numbers, and are remarkable in that strings and numbers are completely interchangable. For example, the statement

$priority = 9;

sets the scalar variable $priority to 9, but you can also assign a string to exactly the same variable:

$priority = 'high';

Perl also accepts numbers as strings, like this:

$priority = '9';
$default = '0009';

and can still cope with arithmetic and other operations quite happily.

In general variable names consists of numbers, letters and underscores, but they should not start with a number and the variable $_ is special, as we’ll see later. Also, Perl is case sensitive, so $a and $A are different.


Operations and Assignment

Perl uses all the usual C arithmetic operators:

$a = 1 + 2;	# Add 1 and 2 and store in $a
$a = 3 - 4;	# Subtract 4 from 3 and store in $a
$a = 5 * 6;	# Multiply 5 and 6
$a = 7 / 8;	# Divide 7 by 8 to give 0.875
$a = 9 ** 10;	# Nine to the power of 10
$a = 5 % 2;	# Remainder of 5 divided by 2
++$a;		# Increment $a and then return it
$a++;		# Return $a and then increment it
--$a;		# Decrement $a and then return it
$a--;		# Return $a and then decrement it

and for strings Perl has the following among others:

$a = $b . $c;	# Concatenate $b and $c
$a = $b x $c;	# $b repeated $c times

To assign values Perl includes

$a = $b;	# Assign $b to $a
$a += $b;	# Add $b to $a
$a -= $b;	# Subtract $b from $a
$a .= $b;	# Append $b onto $a

Note that when Perl assigns a value with $a = $b it makes a copy of $b and then assigns that to $a. Therefore the next time you change $b it will not alter $a.

Other operators can be found on the perlop manual page. Type man perlop at the prompt.


Interpolation

The following code prints apples and pears using concatenation:

$a = 'apples';
$b = 'pears';
print $a.' and '.$b;

It would be nicer to include only one string in the final print statement, but the line

print '$a and $b';

prints literally $a and $b which isn’t very helpful. Instead we can use the double quotes in place of the single quotes:

print "$a and $b";

The double quotes force interpolation of any codes, including interpreting variables. This is a much nicer than our original statement. Other codes that are interpolated include special characters such as newline and tab. The code \nis a newline and \t is a tab.


Exercise

This exercise is to rewrite the Hello world program so that (a) the string is assigned to a variable and (b) this variable is then printed with a newline character. Use the double quotes and don’t use the concatenation operator. Make sure you can get this to work before proceeding.


 Array variables


A slightly more interesting kind of variable is the array variable which is a list of scalars (ie numbers and strings). Array variables have the same format as scalar variables except that they are prefixed by an @ symbol. The statement

@food  = ("apples", "pears", "eels");
@music = ("whistle", "flute");

assigns a three element list to the array variable @food and a two element list to the array variable @music.

The array is accessed by using indices starting from 0, and square brackets are used to specify the index. The expression

$food[2]

returns eels. Notice that the @ has changed to a $ because eels is a scalar.


Array assignments

As in all of Perl, the same expression in a different context can produce a different result. The first assignment below explodes the @music variable so that it is equivalent to the second assignment.

@moremusic = ("organ", @music, "harp");
@moremusic = ("organ", "whistle", "flute", "harp");

This should suggest a way of adding elements to an array. A neater way of adding elements is to use the statement

push(@food, "eggs");

which pushes eggs onto the end of the array @food. To push two or more items onto the array use one of the following forms:

push(@food, "eggs", "lard");
push(@food, ("eggs", "lard"));
push(@food, @morefood);

The push function returns the length of the new list.

To remove the last item from a list and return it use the pop function. From our original list the pop function returns eels and @food now has two elements:

$grub = pop(@food);	# Now $grub = "eels"

It is also possible to assign an array to a scalar variable. As usual context is important. The line

$f = @food;

assigns the length of @food, but

$f = "@food";

turns the list into a string with a space between each element. This space can be replaced by any other string by changing the value of the special $” variable. This variable is just one of Perl’s many special variables, most of which have odd names.

Arrays can also be used to make multiple assignments to scalar variables:

($a, $b) = ($c, $d);		# Same as $a=$c; $b=$d;
($a, $b) = @food;		# $a and $b are the first two
				# items of @food.
($a, @somefood) = @food;	# $a is the first item of @food
				# @somefood is a list of the
				# others.
(@somefood, $a) = @food;	# @somefood is @food and
				# $a is undefined.

The last assignment occurs because arrays are greedy, and @somefood will swallow up as much of @food as it can. Therefore that form is best avoided.

Finally, you may want to find the index of the last element of a list. To do this for the @food array use the expression

$#food

Displaying arrays

Since context is important, it shouldn’t be too surprising that the following all produce different results:

print @food;	# By itself
print "@food";	# Embedded in double quotes
print @food."";	# In a scalar context

Exercise

Try out each of the above three print statements to see what they do.


 File handling


Here is the basic perl program which does the same as the UNIX cat command on a certain file.

#!/usr/local/bin/perl
#
# Program to open the password file, read it in,
# print it, and close it again.

$file = '/etc/passwd';		# Name the file
open(INFO, $file);		# Open the file
@lines = <INFO>;		# Read it into an array
close(INFO);			# Close the file
print @lines;			# Print the array

The open function opens a file for input (i.e. for reading). The first parameter is the filehandle which allows Perl to refer to the file in future. The second parameter is an expression denoting the filename. If the filename was given in quotes then it is taken literally without shell expansion. So the expression ‘~/notes/todolist’ will not be interpreted successfully. If you want to force shell expansion then use angled brackets: that is, use <~/notes/todolist> instead.

The close function tells Perl to finish with that file.

There are a few useful points to add to this discussion on filehandling. First, the open statement can also specify a file for output and for appending as well as for input. To do this, prefix the filename with a > for output and a >> for appending:

open(INFO, $file);	# Open for input
open(INFO, ">$file");	# Open for output
open(INFO, ">>$file");	# Open for appending
open(INFO, "<$file");	# Also open for input

Second, if you want to print something to a file you’ve already opened for output then you can use the print statement with an extra parameter. To print a string to the file with the INFO filehandle use

print INFO "This line goes to the file.\n";

Third, you can use the following to open the standard input (usually the keyboard) and standard output (usually the screen) respectively:

open(INFO, '-');	# Open standard input
open(INFO, '>-');	# Open standard output

In the above program the information is read from a file. The file is the INFO file and to read from it Perl uses angled brackets. So the statement

@lines = <INFO>;

reads the file denoted by the filehandle into the array @lines. Note that the <INFO> expression reads in the file entirely in one go. This because the reading takes place in the context of an array variable. If @lines is replaced by the scalar $lines then only the next one line would be read in. In either case each line is stored complete with its newline character at the end.


Exercise

Modify the above program so that the entire file is printed with a # symbol at the beginning of each line. You should only have to add one line and modify another. Use the $” variable. Unexpected things can happen with files, so you may find it helpful to use the -w option as mentioned in the section on running Perl programs.


 Control structures


More interesting possiblities arise when we introduce control structures and looping. Perl supports lots of different kinds of control structures which tend to be like those in C, but are very similar to Pascal, too. Here we discuss a few of them.


foreach

To go through each line of an array or other list-like structure (such as lines in a file) Perl uses the foreach structure. This has the form

foreach $morsel (@food)		# Visit each item in turn
				# and call it $morsel
{
	print "$morsel\n";	# Print the item
	print "Yum yum\n";	# That was nice
}

The actions to be performed each time are enclosed in a block of curly braces. The first time through the block $morsel is assigned the value of the first item in the array @food. Next time it is assigned the value of the second item, and so until the end. If @food is empty to start with then the block of statements is never executed.


Testing

The next few structures rely on a test being true or false. In Perl any non-zero number and non-empty string is counted as true. The number zero, zero by itself in a string, and the empty string are counted as false. Here are some tests on numbers and strings.

$a == $b		# Is $a numerically equal to $b?
			# Beware: Don't use the = operator.
$a != $b		# Is $a numerically unequal to $b?
$a eq $b		# Is $a string-equal to $b?
$a ne $b		# Is $a string-unequal to $b?

You can also use logical and, or and not:

($a && $b)		# Is $a and $b true?
($a || $b)		# Is either $a or $b true?
!($a)			# is $a false?

for

Perl has a for structure that mimics that of C. It has the form

for (initialise; test; inc)
{
	 first_action;
	 second_action;
	 etc
}

First of all the statement initialise is executed. Then while test is true the block of actions is executed. After each time the block is executed inc takes place. Here is an example for loop to print out the numbers 0 to 9.

for ($i = 0; $i < 10; ++$i)	# Start with $i = 1
				# Do it while $i < 10
				# Increment $i before repeating
{
	print "$i\n";
}

while and until

Here is a program that reads some input from the keyboard and won’t continue until it is the correct password

#!/usr/local/bin/perl
print "Password? ";		# Ask for input
$a = <STDIN>;			# Get input
chop $a;			# Remove the newline at end
while ($a ne "fred")		# While input is wrong...
{
    print "sorry. Again? ";	# Ask again
    $a = <STDIN>;		# Get input again
    chop $a;			# Chop off newline again
}

The curly-braced block of code is executed while the input does not equal the password. The while structure should be fairly clear, but this is the opportunity to notice several things. First, we can we read from the standard input (the keyboard) without opening the file first. Second, when the password is entered $a is given that value including the newline character at the end. The chop function removes the last character of a string which in this case is the newline.

To test the opposite thing we can use the until statement in just the same way. This executes the block repeatedly until the expression is true, not while it is true.

Another useful technique is putting the while or until check at the end of the statement block rather than at the beginning. This will require the presence of the do operator to mark the beginning of the block and the test at the end. If we forgo the sorry. Again message in the above password program then it could be written like this.

#!/usr/local/bin/perl
do
{
	"Password? ";		# Ask for input
	$a = <STDIN>;		# Get input
	chop $a;		# Chop off newline
}
while ($a ne "fred")		# Redo while wrong input

Exercise

Modify the program from the previous exercise so that each line of the file is read in one by one and is output with a line number at the beginning. You should get something like:

1 root:oYpYXm/qRO6N2:0:0:Super-User:/:/bin/csh
2 sysadm:*:0:0:System V Administration:/usr/admin:/bin/sh
3 diag:*:0:996:Hardware Diagnostics:/usr/diags:/bin/csh
etc

You may find it useful to use the structure

while ($line = <INFO>)
{
	...
}

When you have done this see if you can alter it so that line numbers are printed as 001, 002, …, 009, 010, 011, 012, etc. To do this you should only need to change one line by inserting an extra four characters. Perl’s clever like that.


 Conditionals


Of course Perl also allows if/then/else statements. These are of the following form:

if ($a)
{
	print "The string is not empty\n";
}
else
{
	print "The string is empty\n";
}

For this, remember that an empty string is considered to be false. It will also give an “empty” result if $a is the string 0.

It is also possible to include more alternatives in a conditional statement:

if (!$a)			# The ! is the not operator
{
	print "The string is empty\n";
}
elsif (length($a) == 1)		# If above fails, try this
{
	print "The string has one character\n";
}
elsif (length($a) == 2)		# If that fails, try this
{
	print "The string has two characters\n";
}
else				# Now, everything has failed
{
	print "The string has lots of characters\n";
}

In this, it is important to notice that the elsif statement really does have an “e” missing.


Exercise

Find a fairly large file that contains some text and some blank lines. The file Dissertation on Physical Science for your Enlightenment is pretty good because it’s funny apart from anything else. It was originally posted to our local news system by David Herselman.

From the previous exercise you should have a program which prints out the password file with line numbers. Change it so that works with the text file. Now alter the program so that line numbers aren’t printed or counted with blank lines, but every line is still printed, including the blank ones. Remember that when a line of the file is read in it will still include its newline character at the end.


 String matching


One of the most useful features of Perl (if not the most useful feature) is its powerful string manipulation facilities. At the heart of this is the regular expression (RE) which is shared by many other UNIX utilities.


Regular expressions

A regular expression is contained in slashes, and matching occurs with the =~ operator. The following expression is true if the string the appears in variable $sentence.

$sentence =~ /the/

The RE is case sensitive, so if

$sentence = "The quick brown fox";

then the above match will be false. The operator !~ is used for spotting a non-match. In the above example

$sentence !~ /the/

is true because the string the does not appear in $sentence.


The $_ special variable

We could use a conditional as

if ($sentence =~ /under/)
{
	print "We're talking about rugby\n";
}

which would print out a message if we had either of the following

$sentence = "Up and under";
$sentence = "Best winkles in Sunderland";

But it’s often much easier if we assign the sentence to the special variable $_ which is of course a scalar. If we do this then we can avoid using the match and non-match operators and the above can be written simply as

if (/under/)
{
	print "We're talking about rugby\n";
}

The $_ variable is the default for many Perl operations and tends to be used very heavily.


More on REs

In an RE there are plenty of special characters, and it is these that both give them their power and make them appear very complicated. It’s best to build up your use of REs slowly; their creation can be something of an art form.

Here are some special RE characters and their meaning

.	# Any single character except a newline
^	# The beginning of the line or string
$	# The end of the line or string
*	# Zero or more of the last character
+	# One or more of the last character
?	# Zero or one of the last character

and here are some example matches. Remember that should be enclosed in // slashes to be used.

t.e	# t followed by anthing followed by e
	# This will match the
	#                 tre
	#                 tle
	# but not te
	#         tale
^f	# f at the beginning of a line
^ftp	# ftp at the beginning of a line
e$	# e at the end of a line
tle$	# tle at the end of a line
und*	# un followed by zero or more d characters
	# This will match un
	#                 und
	#                 undd
	#                 unddd (etc)
.*	# Any string without a newline. This is because
	# the . matches anything except a newline and
	# the * means zero or more of these.
^$	# A line with nothing in it.

There are even more options. Square brackets are used to match any one of the characters inside them. Inside square brackets a  indicates “between” and a ^ at the beginning means “not”:

[qjk]		# Either q or j or k
[^qjk]		# Neither q nor j nor k
[a-z]		# Anything from a to z inclusive
[^a-z]		# No lower case letters
[a-zA-Z]	# Any letter
[a-z]+		# Any non-zero sequence of lower case letters

At this point you can probably skip to the end and do at least most of the exercise. The rest is mostly just for reference.

A vertical bar | represents an “or” and parentheses () can be used to group things together:

jelly|cream	# Either jelly or cream
(eg|le)gs	# Either eggs or legs
(da)+		# Either da or dada or dadada or...

Here are some more special characters:

\n		# A newline
\t		# A tab
\w		# Any alphanumeric (word) character.
		# The same as [a-zA-Z0-9_]
\W		# Any non-word character.
		# The same as [^a-zA-Z0-9_]
\d		# Any digit. The same as [0-9]
\D		# Any non-digit. The same as [^0-9]
\s		# Any whitespace character: space,
		# tab, newline, etc
\S		# Any non-whitespace character
\b		# A word boundary, outside [] only
\B		# No word boundary

Clearly characters like $, |, [, ), \, / and so on are peculiar cases in regular expressions. If you want to match for one of those then you have to preceed it by a backslash. So:

\|		# Vertical bar
\[		# An open square bracket
\)		# A closing parenthesis
\*		# An asterisk
\^		# A carat symbol
\/		# A slash
\\		# A backslash

and so on.


Some example REs

As was mentioned earlier, it’s probably best to build up your use of regular expressions slowly. Here are a few examples. Remember that to use them for matching they should be put in // slashes

[01]		# Either "0" or "1"
\/0		# A division by zero: "/0"
\/ 0		# A division by zero with a space: "/ 0"
\/\s0		# A division by zero with a whitespace:
		# "/ 0" where the space may be a tab etc.
\/ *0		# A division by zero with possibly some
		# spaces: "/0" or "/ 0" or "/  0" etc.
\/\s*0		# A division by zero with possibly some
		# whitespace.
\/\s*0\.0*	# As the previous one, but with decimal
		# point and maybe some 0s after it. Accepts
		# "/0." and "/0.0" and "/0.00" etc and
		# "/ 0." and "/  0.0" and "/   0.00" etc.

Exercise

Previously your program counted non-empty lines. Alter it so that instead of counting non-empty lines it counts only lines with

  • the letter x
  • the string the
  • the string the which may or may not have a capital t
  • the word the with or without a capital. Use \b to detect word boundaries.

In each case the program should print out every line, but it should only number those specified. Try to use the $_ variable to avoid using the =~ match operator explicitly.


 Substitution and translation


As well as identifying regular expressions Perl can make substitutions based on those matches. The way to do this is to use the s function which is designed to mimic the way substitution is done in the vi text editor. Once again the match operator is used, and once again if it is omitted then the substitution is assumed to take place with the $_ variable.

To replace an occurrence of london by London in the string $sentence we use the expression

$sentence =~ s/london/London/

and to do the same thing with the $_ variable just

s/london/London/

Notice that the two regular expressions (london and London) are surrounded by a total of three slashes. The result of this expression is the number of substitutions made, so it is either 0 (false) or 1 (true) in this case.


Options

This example only replaces the first occurrence of the string, and it may be that there will be more than one such string we want to replace. To make a global substitution the last slash is followed by a g as follows:

s/london/London/g

which of course works on the $_ variable. Again the expression returns the number of substitutions made, which is 0 (false) or something greater than 0 (true).

If we want to also replace occurrences of lOndon, lonDON, LoNDoN and so on then we could use

s/[Ll][Oo][Nn][Dd][Oo][Nn]/London/g

but an easier way is to use the i option (for “ignore case”). The expression

s/london/London/gi

will make a global substitution ignoring case. The i option is also used in the basic // regular expression match.


Remembering patterns

It’s often useful to remember patterns that have been matched so that they can be used again. It just so happens that anything matched in parentheses gets remembered in the variables $1,…,$9. These strings can also be used in the same regular expression (or substitution) by using the special RE codes \1,…,\9. For example

$_ = "Lord Whopper of Fibbing";
s/([A-Z])/:\1:/g;
print "$_\n";

will replace each upper case letter by that letter surrounded by colons. It will print :L:ord :W:hopper of :F:ibbing. The variables $1,…,$9 are read-only variables; you cannot alter them yourself.

As another example, the test

if (/(\b.+\b) \1/)
{
	print "Found $1 repeated\n";
}

will identify any words repeated. Each \b represents a word boundary and the .+ matches any non-empty string, so \b.+\b matches anything between two word boundaries. This is then remembered by the parentheses and stored as\1 for regular expressions and as $1 for the rest of the program.

The following swaps the first and last characters of a line in the $_ variable:

s/^(.)(.*)(.)$/\3\2\1/

The ^ and $ match the beginning and end of the line. The \1 code stores the first character; the \2 code stores everything else up the last character which is stored in the \3 code. Then that whole line is replaced with \1 and \3swapped round.

After a match, you can use the special read-only variables $` and $& and $’ to find what was matched before, during and after the seach. So after

$_ = "Lord Whopper of Fibbing";
/pp/;

all of the following are true. (Remember that eq is the string-equality test.)

$` eq "Lord Wo";
$& eq "pp";
$' eq "er of Fibbing";

Finally on the subject of remembering patterns it’s worth knowing that inside of the slashes of a match or a substitution variables are interpolated. So

$search = "the";
s/$search/xxx/g;

will replace every occurrence of the with xxx. If you want to replace every occurence of there then you cannot do s/$searchre/xxx/ because this will be interpolated as the variable $searchre. Instead you should put the variable name in curly braces so that the code becomes

$search = "the";
s/${search}re/xxx/;

Translation

The tr function allows character-by-character translation. The following expression replaces each a with e, each b with d, and each c with f in the variable $sentence. The expression returns the number of substitutions made.

$sentence =~ tr/abc/edf/

Most of the special RE codes do not apply in the tr function. For example, the statement here counts the number of asterisks in the $sentence variable and stores that in the $count variable.

$count = ($sentence =~ tr/*/*/);

However, the dash is still used to mean “between”. This statement converts $_ to upper case.

tr/a-z/A-Z/;

Exercise

Your current program should count lines of a file which contain a certain string. Modify it so that it counts lines with double letters (or any other double character). Modify it again so that these double letters appear also in parentheses. For example your program would produce a line like this among others:

023 Amp, James Wa(tt) & Bob Transformer. These pion(ee)rs conducted many

Try to get it so that all pairs of letters are in parentheses, not just the first pair on each line.

For a slightly more interesting program you might like to try the following. Suppose your program is called countlines. Then you would call it with

./countlines

However, if you call it with several arguments, as in

./countlines first second etc

then those arguments are stored in the array @ARGV. In the above example we have $ARGV[0] is first and $ARGV[1] is second and $ARGV[2] is etc. Modify your program so that it accepts one argument and counts only those lines with that string. It should also put occurrences of this string in paretheses. So

./countlines the

will output something like this line among others:

019 But (the) greatest Pioneer of (the)m all was Thomas Edison, who

 Split


A very useful function in Perl is split, which splits up a string and places it into an array. The function uses a regular expression and as usual works on the $_ variable unless otherwise specified.

The split function is used like this:

$info = "Caine:Michael:Actor:14, Leafy Drive";
@personal = split(/:/, $info);

which has the same overall effect as

@personal = ("Caine", "Michael", "Actor", "14, Leafy Drive");

If we have the information stored in the $_ variable then we can just use this instead

@personal = split(/:/);

If the fields are divided by any number of colons then we can use the RE codes to get round this. The code

$_ = "Capes:Geoff::Shot putter:::Big Avenue";
@personal = split(/:+/);

is the same as

@personal = ("Capes", "Geoff",
             "Shot putter", "Big Avenue");

But this:

$_ = "Capes:Geoff::Shot putter:::Big Avenue";
@personal = split(/:/);

would be like

@personal = ("Capes", "Geoff", "",
             "Shot putter", "", "", "Big Avenue");

A word can be split into characters, a sentence split into words and a paragraph split into sentences:

@chars = split(//, $word);
@words = split(/ /, $sentence);
@sentences = split(/\./, $paragraph);

In the first case the null string is matched between each character, and that is why the @chars array is an array of characters – ie an array of strings of length 1.


Exercise

A useful tool in natural language processing is concordance. This allows a specific string to be displayed in its immediate context whereever it appears in a text. For example, a concordance program identifying the target string themight produce some of the following output. Notice how the occurrences of the target string line up vertically.

discovered (this is the truth) that when he
t kinds of metal to the leg of a frog, an e
rrent developed and the frog's leg kicked,
 longer attached to the frog, which was dea
normous advances in the field of amphibian
ch it hop back into the pond -- almost.  Bu
ond -- almost.  But the greatest Electrical
ectrical Pioneer of them all was Thomas Edi

This exercise is to write such a program. Here are some tips:

  • Read the entire file into array (this obviously isn’t useful in general because the file may be extremely large, but we won’t worry about that here). Each item in the array will be a line of the file.
  • When the chop function is used on an array it chops off the last character of every item in the array.
  • Recall that you can join the whole array together with a statement like $text = “@lines”;
  • Use the target string as delimiter for splitting the text. (Ie, use the target string in place of the colon in our previous examples.) You should then have an array of all the strings between the target strings.
  • For each array element in turn, print it out, print the target string, and then print the next array element.
  • Recall that the last element of an array @food has index $#food.

As it stands this would be a pretty good program, but the target strings won’t line up vertically. To tidy up the strings you’ll need the substr function. Here are three examples of its use.

substr("Once upon a time", 3, 4);	# returns "e up"
substr("Once upon a time", 7);		# returns "on a time"
substr("Once upon a time", -6, 5);	# returns "a tim"

The first example returns a substring of length 4 starting at position 3. Remember that the first character of a string has index 0. The second example shows that missing out the length gives the substring right to the end of the string The third example shows that you can also index from the end using a negative index. It returns the substring that starts at the 6th character from the end and has length 5.

If you use a negative index that extends beyond the beginning of the string then Perl will return nothing or give a warning. To avoid this happening you can pad out the string by using the x operator mentioned earlier. The expression (” “x30) produces 30 spaces, for example.


 Associative arrays


Ordinary list arrays allow us to access their element by number. The first element of array @food is $food[0]. The second element is $food[1], and so on. But Perl also allows us to create arrays which are accessed by string. These are called associative arrays.

To define an associative array we use the usual parenthesis notation, but the array itself is prefixed by a % sign. Suppose we want to create an array of people and their ages. It would look like this:

%ages = ("Michael Caine", 39,
         "Dirty Den", 34,
         "Angie", 27,
         "Willy", "21 in dog years",
         "The Queen Mother", 108);

Now we can find the age of people with the following expressions

$ages{"Michael Caine"};		# Returns 39
$ages{"Dirty Den"};		# Returns 34
$ages{"Angie"};			# Returns 27
$ages{"Willy"};			# Returns "21 in dog years"
$ages{"The Queen Mother"};	# Returns 108

Notice that like list arrays each % sign has changed to a $ to access an individual element because that element is a scalar. Unlike list arrays the index (in this case the person’s name) is enclosed in curly braces, the idea being that associative arrays are fancier than list arrays.

An associative array can be converted back into a list array just by assigning it to a list array variable. A list array can be converted into an associative array by assigning it to an associative array variable. Ideally the list array will have an even number of elements:

@info = %ages;		# @info is a list array. It
			# now has 10 elements
$info[5];		# Returns the value 27 from
			# the list array @info
%moreages = @info;	# %moreages is an associative
			# array. It is the same as %ages

Operators

Associative arrays do not have any order to their elements (they are just like hash tables) but is it possible to access all the elements in turn using the keys function and the values function:

foreach $person (keys %ages)
{
	print "I know the age of $person\n";
}
foreach $age (values %ages)
{
	print "Somebody is $age\n";
}

When keys is called it returns a list of the keys (indices) of the associative array. When values is called it returns a list of the values of the array. These functions return their lists in the same order, but this order has nothing to do with the order in which the elements have been entered.

When keys and values are called in a scalar context they return the number of key/value pairs in the associative array.

There is also a function each which returns a two element list of a key and its value. Every time each is called it returns another key/value pair:

while (($person, $age) = each(%ages))
{
	print "$person is $age\n";
}

Environment variables

When you run a perl program, or any script in UNIX, there will be certain environment variables set. These will be things like USER which contains your username and DISPLAY which specifies which screen your graphics will go to. When you run a perl CGI script on the World Wide Web there are environment variables which hold other useful information. All these variables and their values are stored in the associative %ENV array in which the keys are the variable names. Try the following in a perl program:

print "You are called $ENV{'USER'} and you are ";
print "using display $ENV{'DISPLAY'}\n";

 Subroutines


Like any good programming langauge Perl allows the user to define their own functions, called subroutines. They may be placed anywhere in your program but it’s probably best to put them all at the beginning or all at the end. A subroutine has the form

sub mysubroutine
{
	print "Not a very interesting routine\n";
	print "This does the same thing every time\n";
}

regardless of any parameters that we may want to pass to it. All of the following will work to call this subroutine. Notice that a subroutine is called with an & character in front of the name:

&mysubroutine;		# Call the subroutine
&mysubroutine($_);	# Call it with a parameter
&mysubroutine(1+2, $_);	# Call it with two parameters

Parameters

In the above case the parameters are acceptable but ignored. When the subroutine is called any parameters are passed as a list in the special @_ list array variable. This variable has absolutely nothing to do with the $_ scalar variable. The following subroutine merely prints out the list that it was called with. It is followed by a couple of examples of its use.

sub printargs
{
	print "@_\n";
}

&printargs("perly", "king");	# Example prints "perly king"
&printargs("frog", "and", "toad"); # Prints "frog and toad"

Just like any other list array the individual elements of @_ can be accessed with the square bracket notation:

sub printfirsttwo
{
	print "Your first argument was $_[0]\n";
	print "and $_[1] was your second\n";
}

Again it should be stressed that the indexed scalars $_[0] and $_[1] and so on have nothing to with the scalar $_ which can also be used without fear of a clash.


Returning values

Result of a subroutine is always the last thing evaluated. This subroutine returns the maximum of two input parameters. An example of its use follows.

sub maximum
{
	if ($_[0] > $_[1])
	{
		$_[0];
	}
	else
	{
		$_[1];
	}
}

$biggest = &maximum(37, 24);	# Now $biggest is 37

The &printfirsttwo subroutine above also returns a value, in this case 1. This is because the last thing that subroutine did was a print statement and the result of a successful print statement is always 1.


Local variables

The @_ variable is local to the current subroutine, and so of course are $_[0]$_[1]$_[2], and so on. Other variables can be made local too, and this is useful if we want to start altering the input parameters. The following subroutine tests to see if one string is inside another, spaces not withstanding. An example follows.

sub inside
{
	local($a, $b);			# Make local variables
	($a, $b) = ($_[0], $_[1]);	# Assign values
	$a =~ s/ //g;			# Strip spaces from
	$b =~ s/ //g;			#   local variables
	($a =~ /$b/ || $b =~ /$a/);	# Is $b inside $a
					#   or $a inside $b?
}

&inside("lemon", "dole money");		# true

In fact, it can even be tidied up by replacing the first two lines with

local($a, $b) = ($_[0], $_[1]);