a2p
accept
access
acct
addftinfo
addr2line
adjtime
afmtodit
after
aio_cancel
aio_error
aio_read
aio_return
aio_suspend
aio_waitcomplete
aio_write
alias
aliases
alloc
anvil
append
apply
apropos
ar
array
as
asa
asn1parse
at
atq
atrm
attemptckalloc
attemptckrealloc
authlib
authtest
autopoint
awk
b64decode
b64encode
basename
batch
bc
bdes
bell
bg
bgerror
biff
big5
binary
bind
bindkey
bindtags
bindtextdomain
bio
bitmap
blowfish
bn
bootparams
bootptab
bounce
brandelf
break
breaksw
brk
bsdiff
bsdtar
bsnmpd
bspatch
bthost
btsockstat
buffer
builtin
builtins
bunzip2
button
byacc
bzcat
bzegrep
bzfgrep
bzgrep
bzip2
c2ph
c89
c99
ca
cal
calendar
canvas
cap_mkdb
case
cat
catch
catman
cc
cd
cdcontrol
chdir
checkbutton
checknr
chflags
chfn
chgrp
chio
chkey
chmod
chown
chpass
chroot
chsh
ci
ciphers
ckalloc
ckdist
ckfree
ckrealloc
cksum
cleanup
clear
clipboard
clock
clock_getres
clock_gettime
clock_settime
close
cmp
co
col
colcrt
colldef
colors
colrm
column
comm
command
compile_et
complete
compress
concat
config
connect
console
continue
core
courierlogger
couriertcpd
cp
cpan
cpio
cpp
creat
crl
crontab
crunchgen
crunchide
crypt
crypto
csh
csplit
ctags
ctm
ctm_dequeue
ctm_rmail
ctm_smail
cu
cursor
cursors
cut
cvs
date
dbiprof
dbiproxy
dc
dcgettext
dcngettext
dd
dde
default
defer
deliverquota
des
destroy
devfs
df
dgettext
dgst
dh
dhparam
dialog
diff
diff3
dig
dir
dirent
dirname
dirs
discard
disktab
dngettext
do
domainname
done
dprofpp
dsa
dsaparam
dtmfdecode
du
dup
dup2
eaccess
ec
ecdsa
echo
echotc
ecparam
ed
edit
editrc
ee
egrep
elf
elfdump
elif
else
enc
enc2xs
encoding
end
endif
endsw
engine
enigma
entry
env
envsubst
eof
eqn
err
errno
error
errstr
esac
ethers
euc
eui64
eval
event
evp
ex
exec
execve
exit
expand
export
exports
expr
extattr
extattr_delete_fd
extattr_delete_file
extattr_get_fd
extattr_get_file
extattr_set_fd
extattr_set_file
f77
false
famm
famx
fblocked
fbtab
fc
fchdir
fchflags
fchmod
fchown
fcntl
fconfigure
fcopy
fdescfs
fdformat
fdread
fdwrite
fetch
fg
fgrep
fhopen
fhstat
fhstatfs
fi
file
file2c
fileevent
filename
filetest
find
find2perl
finger
flex
flock
flush
fmt
focus
fold
font
fontedit
for
foreach
fork
format
forward
fpathconf
frame
from
fs
fstab
fstat
fstatfs
fsync
ftp
ftpchroot
ftpusers
ftruncate
futimes
g711conv
gb2312
gb18030
gbk
gcc
gcore
gcov
gdb
gencat
gendsa
genrsa
gensnmptree
getconf
getdents
getdirentries
getdtablesize
getegid
geteuid
getfacl
getfh
getfsstat
getgid
getgroups
getitimer
getlogin
getopt
getopts
getpeername
getpgid
getpgrp
getpid
getppid
getpriority
getresgid
getresuid
getrlimit
getrusage
gets
getsid
getsockname
getsockopt
gettext
gettextize
gettimeofday
gettytab
getuid
glob
global
gmake
goto
gperf
gprof
grab
grep
grid
grn
grodvi
groff
groff_font
groff_out
groff_tmac
grog
grolbp
grolj4
grops
grotty
group
groups
gunzip
gzcat
gzexe
gzip
h2ph
h2xs
hash
hashstat
hd
head
help2man
hesinfo
hexdump
history
host
hostname
hosts
hosts_access
hosts_options
hpftodit
http
hup
i386_get_ioperm
i386_get_ldt
i386_set_ioperm
i386_set_ldt
i386_vm86
iconv
id
ident
idprio
if
ifnames253
ifnames259
image
imapd
incr
indent
indxbib
info
infokey
inode
install
instmodsh
interp
intro
introduction
ioctl
ipcrm
ipcs
ipf
ipftest
ipnat
ippool
ipresend
issetugid
jail
jail_attach
jobid
jobs
join
jot
kbdcontrol
kbdmap
kcon
kdestroy
kdump
kenv
kevent
keycap
keylogin
keylogout
keymap
keysyms
kgdb
kill
killall
killpg
kinit
kldfind
kldfirstmod
kldload
kldnext
kldstat
kldsym
kldunload
klist
kpasswd
kqueue
kse
kse_create
kse_exit
kse_release
kse_switchin
kse_thr_interrupt
kse_wakeup
ktrace
label
labelframe
lam
lappend
last
lastcomm
lastlog
lchflags
lchmod
lchown
ld
ldap
ldapadd
ldapcompare
ldapdelete
ldapmodify
ldapmodrdn
ldappasswd
ldapsearch
ldapwhoami
ldd
leave
less
lesskey
lex
lgetfh
lhash
libnetcfg
library
limit
limits
lindex
link
linprocfs
linsert
lint
lio_listio
list
listbox
listen
lj4_font
lkbib
llength
lmtp
ln
load
loadfont
local
locale
locate
lock
lockf
log
logger
login
logins
logname
logout
look
lookbib
lorder
lower
lp
lpq
lpr
lprm
lptest
lrange
lreplace
ls
lsearch
lseek
lset
lsort
lstat
lsvfs
lutimes
lynx
m4
madvise
magic
mail
maildiracl
maildirkw
maildirmake
mailq
mailx
make
makeinfo
makewhatis
man
manpath
master
mc
mcedit
mcview
md2
md4
md5
mdc2
memory
menu
menubar
menubutton
merge
mesg
message
mincore
minherit
minigzip
mkdep
mkdir
mkfifo
mkimapdcert
mklocale
mknod
mkpop3dcert
mkstr
mktemp
mlock
mlockall
mmap
mmroff
modfind
modfnext
modnext
modstat
moduli
more
motd
mount
mprotect
mptable
msdos
msdosfs
msgattrib
msgcat
msgcmp
msgcomm
msgconv
msgen
msgexec
msgfilter
msgfmt
msggrep
msginit
msgmerge
msgs
msgunfmt
msguniq
mskanji
msql2mysql
msync
mt
munlock
munlockall
munmap
mv
myisamchk
myisamlog
myisampack
mysql
mysqlaccess
mysqladmin
mysqlbinlog
mysqlcheck
mysqld
mysqldump
mysqld_multi
mysqld_safe
mysqlhotcopy
mysqlimport
mysqlshow
mysql_config
mysql_fix_privilege_tables
mysql_zap
namespace
nanosleep
nawk
nc
ncal
ncplist
ncplogin
ncplogout
neqn
netconfig
netgroup
netid
netstat
networks
newaliases
newgrp
nex
nfsstat
nfssvc
ngettext
nice
nl
nm
nmount
nohup
nologin
notify
nroff
nseq
nslookup
ntp_adjtime
ntp_gettime
nvi
nview
objcopy
objdump
objformat
ocsp
od
onintr
open
openssl
opieaccess
opieinfo
opiekey
opiekeys
opiepasswd
option
options
oqmgr
pack
package
packagens
pagesize
palette
pam_auth
panedwindow
parray
passwd
paste
patch
pathchk
pathconf
pawd
pax
pbm
pcre
pcreapi
pcrebuild
pcrecallout
pcrecompat
pcrecpp
pcregrep
pcrematching
pcrepartial
pcrepattern
pcreperform
pcreposix
pcreprecompile
pcresample
pcretest
perl
perl56delta
perl58delta
perl561delta
perl570delta
perl571delta
perl572delta
perl573delta
perl581delta
perl582delta
perl583delta
perl584delta
perl585delta
perl586delta
perl587delta
perl588delta
perl5004delta
perl5005delta
perlaix
perlamiga
perlapi
perlapio
perlapollo
perlartistic
perlbeos
perlbook
perlboot
perlbot
perlbs2000
perlbug
perlcall
perlcc
perlce
perlcheat
perlclib
perlcn
perlcompile
perlcygwin
perldata
perldbmfilter
perldebguts
perldebtut
perldebug
perldelta
perldgux
perldiag
perldoc
perldos
perldsc
perlebcdic
perlembed
perlepoc
perlfaq
perlfaq1
perlfaq2
perlfaq3
perlfaq4
perlfaq5
perlfaq6
perlfaq7
perlfaq8
perlfaq9
perlfilter
perlfork
perlform
perlfreebsd
perlfunc
perlglossary
perlgpl
perlguts
perlhack
perlhist
perlhpux
perlhurd
perlintern
perlintro
perliol
perlipc
perlirix
perlivp
perljp
perlko
perllexwarn
perllinux
perllocale
perllol
perlmachten
perlmacos
perlmacosx
perlmint
perlmod
perlmodinstall
perlmodlib
perlmodstyle
perlmpeix
perlnetware
perlnewmod
perlnumber
perlobj
perlop
perlopenbsd
perlopentut
perlos2
perlos390
perlos400
perlothrtut
perlpacktut
perlplan9
perlpod
perlpodspec
perlport
perlqnx
perlre
perlref
perlreftut
perlrequick
perlreref
perlretut
perlrun
perlsec
perlsolaris
perlstyle
perlsub
perlsyn
perlthrtut
perltie
perltoc
perltodo
perltooc
perltoot
perltrap
perltru64
perltw
perlunicode
perluniintro
perlutil
perluts
perlvar
perlvmesa
perlvms
perlvos
perlwin32
perlxs
perlxstut
perror
pfbtops
pftp
pgrep
phones
photo
pic
pickup
piconv
pid
pipe
pkcs7
pkcs8
pkcs12
pkg_add
pkg_check
pkg_create
pkg_delete
pkg_info
pkg_sign
pkg_version
pkill
pl2pm
place
pod2html
pod2latex
pod2man
pod2text
pod2usage
podchecker
podselect
poll
popd
popup
posix_madvise
postalias
postcat
postconf
postdrop
postfix
postkick
postlock
postlog
postmap
postqueue
postsuper
pr
pread
preadv
printcap
printenv
printf
proc
procfs
profil
protocols
prove
proxymap
ps
psed
psroff
pstruct
ptrace
publickey
pushd
puts
pwd
pwrite
pwritev
qmgr
qmqpd
quota
quotactl
radiobutton
raise
rand
ranlib
rcp
rcs
rcsclean
rcsdiff
rcsfile
rcsfreeze
rcsintro
rcsmerge
read
readelf
readlink
readonly
readv
realpath
reboot
recv
recvfrom
recvmsg
red
ree
refer
regexp
registry
regsub
rehash
remote
rename
repeat
replace
req
reset
resolver
resource
return
rev
revoke
rfcomm_sppd
rfork
rhosts
ripemd
ripemd160
rlog
rlogin
rm
rmd160
rmdir
rpc
rpcgen
rs
rsa
rsautl
rsh
rtld
rtprio
rup
ruptime
rusers
rwall
rwho
s2p
safe
sasl
sasldblistusers2
saslpasswd2
sbrk
scache
scale
scan
sched
sched_getparam
sched_getscheduler
sched_get_priority_max
sched_get_priority_min
sched_rr_get_interval
sched_setparam
sched_setscheduler
sched_yield
scon
scp
script
scrollbar
sdiff
sed
seek
select
selection
semctl
semget
semop
send
sendbug
sendfile
sendmail
sendmsg
sendto
services
sess_id
set
setegid
setenv
seteuid
setfacl
setgid
setgroups
setitimer
setlogin
setpgid
setpgrp
setpriority
setregid
setresgid
setresuid
setreuid
setrlimit
setsid
setsockopt
settc
settimeofday
setty
setuid
setvar
sftp
sh
sha
sha1
sha256
shar
shells
shift
shmat
shmctl
shmdt
shmget
showq
shutdown
sigaction
sigaltstack
sigblock
sigmask
sigpause
sigpending
sigprocmask
sigreturn
sigsetmask
sigstack
sigsuspend
sigvec
sigwait
size
slapadd
slapcat
slapd
slapdn
slapindex
slappasswd
slaptest
sleep
slogin
slurpd
smbutil
smime
smtp
smtpd
socket
socketpair
sockstat
soelim
sort
source
spawn
speed
spinbox
spkac
splain
split
squid
squid_ldap_auth
squid_ldap_group
squid_unix_group
sscop
ssh
sshd_config
ssh_config
stab
startslip
stat
statfs
stop
string
strings
strip
stty
su
subst
sum
suspend
swapoff
swapon
switch
symlink
sync
sysarch
syscall
sysconftool
sysconftoolcheck
systat
s_client
s_server
s_time
tabs
tail
talk
tar
tbl
tclsh
tcltest
tclvars
tcopy
tcpdump
tcpslice
tcsh
tee
tell
telltc
telnet
term
termcap
terminfo
test
texindex
texinfo
text
textdomain
tfmtodit
tftp
then
threads
time
tip
tk
tkerror
tkvars
tkwait
tlsmgr
tmac
top
toplevel
touch
tput
tr
trace
trafshow
trap
troff
true
truncate
truss
tset
tsort
tty
ttys
type
tzfile
ui
ul
ulimit
umask
unalias
uname
uncomplete
uncompress
undelete
unexpand
unhash
unifdef
unifdefall
uniq
units
unknown
unlimit
unlink
unmount
unset
unsetenv
until
unvis
update
uplevel
uptime
upvar
usbhidaction
usbhidctl
users
utf8
utimes
utmp
utrace
uudecode
uuencode
uuidgen
vacation
variable
verify
version
vfork
vgrind
vgrindefs
vi
vidcontrol
vidfont
view
virtual
vis
vt220keys
vwait
w
wait
wait3
wait4
waitpid
wall
wc
wget
what
whatis
where
whereis
which
while
who
whoami
whois
window
winfo
wish
wm
write
writev
wtmp
x509
xargs
xgettext
xmlwf
xstr
xsubpp
yacc
yes
ypcat
ypchfn
ypchpass
ypchsh
ypmatch
yppasswd
ypwhich
yyfix
zcat
zcmp
zdiff
zegrep
zfgrep
zforce
zgrep
zmore
znew
_exit
__syscall
 
FreeBSD/Linux/UNIX General Commands Manual
Hypertext Man Pages
perlreftut
 
PERLREFTUT(1)	       Perl Programmers Reference Guide 	 PERLREFTUT(1)



NAME
       perlreftut - Mark's very short tutorial about references

DESCRIPTION
       One of the most important new features in Perl 5 was the capability to
       manage complicated data structures like multidimensional arrays and
       nested hashes.  To enable these, Perl 5 introduced a feature called
       `references', and using references is the key to managing complicated,
       structured data in Perl.  Unfortunately, there's a lot of funny syntax
       to learn, and the main manual page can be hard to follow.  The manual
       is quite complete, and sometimes people find that a problem, because it
       can be hard to tell what is important and what isn't.

       Fortunately, you only need to know 10% of what's in the main page to
       get 90% of the benefit.	This page will show you that 10%.

Who Needs Complicated Data Structures?
       One problem that came up all the time in Perl 4 was how to represent a
       hash whose values were lists.  Perl 4 had hashes, of course, but the
       values had to be scalars; they couldn't be lists.

       Why would you want a hash of lists?  Let's take a simple example: You
       have a file of city and country names, like this:

	       Chicago, USA
	       Frankfurt, Germany
	       Berlin, Germany
	       Washington, USA
	       Helsinki, Finland
	       New York, USA

       and you want to produce an output like this, with each country men-
       tioned once, and then an alphabetical list of the cities in that coun-
       try:

	       Finland: Helsinki.
	       Germany: Berlin, Frankfurt.
	       USA:  Chicago, New York, Washington.

       The natural way to do this is to have a hash whose keys are country
       names.  Associated with each country name key is a list of the cities
       in that country.  Each time you read a line of input, split it into a
       country and a city, look up the list of cities already known to be in
       that country, and append the new city to the list.  When you're done
       reading the input, iterate over the hash as usual, sorting each list of
       cities before you print it out.

       If hash values can't be lists, you lose.  In Perl 4, hash values can't
       be lists; they can only be strings.  You lose.  You'd probably have to
       combine all the cities into a single string somehow, and then when time
       came to write the output, you'd have to break the string into a list,
       sort the list, and turn it back into a string.  This is messy and
       error-prone.  And it's frustrating, because Perl already has perfectly
       good lists that would solve the problem if only you could use them.

The Solution
       By the time Perl 5 rolled around, we were already stuck with this
       design: Hash values must be scalars.  The solution to this is refer-
       ences.

       A reference is a scalar value that refers to an entire array or an
       entire hash (or to just about anything else).  Names are one kind of
       reference that you're already familiar with.  Think of the President of
       the United States: a messy, inconvenient bag of blood and bones.  But
       to talk about him, or to represent him in a computer program, all you
       need is the easy, convenient scalar string "George Bush".

       References in Perl are like names for arrays and hashes.  They're
       Perl's private, internal names, so you can be sure they're unambiguous.
       Unlike "George Bush", a reference only refers to one thing, and you
       always know what it refers to.  If you have a reference to an array,
       you can recover the entire array from it.  If you have a reference to a
       hash, you can recover the entire hash.  But the reference is still an
       easy, compact scalar value.

       You can't have a hash whose values are arrays; hash values can only be
       scalars.  We're stuck with that.  But a single reference can refer to
       an entire array, and references are scalars, so you can have a hash of
       references to arrays, and it'll act a lot like a hash of arrays, and
       it'll be just as useful as a hash of arrays.

       We'll come back to this city-country problem later, after we've seen
       some syntax for managing references.

Syntax
       There are just two ways to make a reference, and just two ways to use
       it once you have it.

       Making References

       MMaakkee RRuullee 11

       If you put a "\" in front of a variable, you get a reference to that
       variable.

	   $aref = \@array;	    # $aref now holds a reference to @array
	   $href = \%hash;	    # $href now holds a reference to %hash
	   $sref = \$scalar;	    # $sref now holds a reference to $scalar

       Once the reference is stored in a variable like $aref or $href, you can
       copy it or store it just the same as any other scalar value:

	   $xy = $aref; 	    # $xy now holds a reference to @array
	   $p[3] = $href;	    # $p[3] now holds a reference to %hash
	   $z = $p[3];		    # $z now holds a reference to %hash

       These examples show how to make references to variables with names.
       Sometimes you want to make an array or a hash that doesn't have a name.
       This is analogous to the way you like to be able to use the string "\n"
       or the number 80 without having to store it in a named variable first.

       Make Rule 2

       "[ ITEMS ]" makes a new, anonymous array, and returns a reference to
       that array.  "{ ITEMS }" makes a new, anonymous hash, and returns a
       reference to that hash.

	   $aref = [ 1, "foo", undef, 13 ];
	   # $aref now holds a reference to an array

	   $href = { APR => 4, AUG => 8 };
	   # $href now holds a reference to a hash

       The references you get from rule 2 are the same kind of references that
       you get from rule 1:

	       # This:
	       $aref = [ 1, 2, 3 ];

	       # Does the same as this:
	       @array = (1, 2, 3);
	       $aref = \@array;

       The first line is an abbreviation for the following two lines, except
       that it doesn't create the superfluous array variable @array.

       If you write just "[]", you get a new, empty anonymous array.  If you
       write just "{}", you get a new, empty anonymous hash.

       Using References

       What can you do with a reference once you have it?  It's a scalar
       value, and we've seen that you can store it as a scalar and get it back
       again just like any scalar.  There are just two more ways to use it:

       UUssee RRuullee 11

       You can always use an array reference, in curly braces, in place of the
       name of an array.  For example, "@{$aref}" instead of @array.

       Here are some examples of that:

       Arrays:

	       @a	       @{$aref} 	       An array
	       reverse @a      reverse @{$aref}        Reverse the array
	       $a[3]	       ${$aref}[3]	       An element of the array
	       $a[3] = 17;     ${$aref}[3] = 17        Assigning an element

       On each line are two expressions that do the same thing.  The left-hand
       versions operate on the array @a.  The right-hand versions operate on
       the array that is referred to by $aref.	Once they find the array
       they're operating on, both versions do the same things to the arrays.

       Using a hash reference is exactly the same:

	       %h	       %{$href} 	     A hash
	       keys %h	       keys %{$href}	     Get the keys from the hash
	       $h{'red'}       ${$href}{'red'}	     An element of the hash
	       $h{'red'} = 17  ${$href}{'red'} = 17  Assigning an element

       Whatever you want to do with a reference, Use Rule 1 tells you how to
       do it.  You just write the Perl code that you would have written for
       doing the same thing to a regular array or hash, and then replace the
       array or hash name with "{$reference}".	"How do I loop over an array
       when all I have is a reference?"  Well, to loop over an array, you
       would write

	       for my $element (@array) {
		  ...
	       }

       so replace the array name, @array, with the reference:

	       for my $element (@{$aref}) {
		  ...
	       }

       "How do I print out the contents of a hash when all I have is a refer-
       ence?"  First write the code for printing out a hash:

	       for my $key (keys %hash) {
		 print "$key => $hash{$key}\n";
	       }

       And then replace the hash name with the reference:

	       for my $key (keys %{$href}) {
		 print "$key => ${$href}{$key}\n";
	       }

       UUssee RRuullee 22

       Use Rule 1 is all you really need, because it tells you how to do abso-
       lutely everything you ever need to do with references.  But the most
       common thing to do with an array or a hash is to extract a single ele-
       ment, and the Use Rule 1 notation is cumbersome.  So there is an abbre-
       viation.

       "${$aref}[3]" is too hard to read, so you can write "$aref->[3]"
       instead.

       "${$href}{red}" is too hard to read, so you can write "$href->{red}"
       instead.

       If $aref holds a reference to an array, then "$aref->[3]" is the fourth
       element of the array.  Don't confuse this with $aref[3], which is the
       fourth element of a totally different array, one deceptively named
       @aref.  $aref and @aref are unrelated the same way that $item and @item
       are.

       Similarly, "$href->{'red'}" is part of the hash referred to by the
       scalar variable $href, perhaps even one with no name.  $href{'red'} is
       part of the deceptively named %href hash.  It's easy to forget to leave
       out the "->", and if you do, you'll get bizarre results when your pro-
       gram gets array and hash elements out of totally unexpected hashes and
       arrays that weren't the ones you wanted to use.

       An Example

       Let's see a quick example of how all this is useful.

       First, remember that "[1, 2, 3]" makes an anonymous array containing
       "(1, 2, 3)", and gives you a reference to that array.

       Now think about

	       @a = ( [1, 2, 3],
		      [4, 5, 6],
		      [7, 8, 9]
		    );

       @a is an array with three elements, and each one is a reference to
       another array.

       $a[1] is one of these references.  It refers to an array, the array
       containing "(4, 5, 6)", and because it is a reference to an array, Use
       Rule 2 says that we can write $a[1]->[2] to get the third element from
       that array.  $a[1]->[2] is the 6.  Similarly, $a[0]->[1] is the 2.
       What we have here is like a two-dimensional array; you can write
       $a[ROW]->[COLUMN] to get or set the element in any row and any column
       of the array.

       The notation still looks a little cumbersome, so there's one more
       abbreviation:

       Arrow Rule

       In between two subscripts, the arrow is optional.

       Instead of $a[1]->[2], we can write $a[1][2]; it means the same thing.
       Instead of "$a[0]->[1] = 23", we can write "$a[0][1] = 23"; it means
       the same thing.

       Now it really looks like two-dimensional arrays!

       You can see why the arrows are important.  Without them, we would have
       had to write "${$a[1]}[2]" instead of $a[1][2].	For three-dimensional
       arrays, they let us write $x[2][3][5] instead of the unreadable
       "${${$x[2]}[3]}[5]".

Solution
       Here's the answer to the problem I posed earlier, of reformatting a
       file of city and country names.

	   1   my %table;

	   2   while (<>) {
	   3	chomp;
	   4	 my ($city, $country) = split /, /;
	   5	 $table{$country} = [] unless exists $table{$country};
	   6	 push @{$table{$country}}, $city;
	   7   }

	   8   foreach $country (sort keys %table) {
	   9	 print "$country: ";
	  10	 my @cities = @{$table{$country}};
	  11	 print join ', ', sort @cities;
	  12	 print ".\n";
	  13   }

       The program has two pieces: Lines 2--7 read the input and build a data
       structure, and lines 8-13 analyze the data and print out the report.
       We're going to have a hash, %table, whose keys are country names, and
       whose values are references to arrays of city names.  The data struc-
       ture will look like this:

		  %table
	       +-------+---+
	       |       |   |   +-----------+--------+
	       |Germany| *---->| Frankfurt | Berlin |
	       |       |   |   +-----------+--------+
	       +-------+---+
	       |       |   |   +----------+
	       |Finland| *---->| Helsinki |
	       |       |   |   +----------+
	       +-------+---+
	       |       |   |   +---------+------------+----------+
	       |  USA  | *---->| Chicago | Washington | New York |
	       |       |   |   +---------+------------+----------+
	       +-------+---+

       We'll look at output first.  Supposing we already have this structure,
       how do we print it out?

	   8   foreach $country (sort keys %table) {
	   9	 print "$country: ";
	  10	 my @cities = @{$table{$country}};
	  11	 print join ', ', sort @cities;
	  12	 print ".\n";
	  13   }

       %table is an ordinary hash, and we get a list of keys from it, sort the
       keys, and loop over the keys as usual.  The only use of references is
       in line 10.  $table{$country} looks up the key $country in the hash and
       gets the value, which is a reference to an array of cities in that
       country.  Use Rule 1 says that we can recover the array by saying
       "@{$table{$country}}".  Line 10 is just like

	       @cities = @array;

       except that the name "array" has been replaced by the reference "{$ta-
       ble{$country}}".  The "@" tells Perl to get the entire array.  Having
       gotten the list of cities, we sort it, join it, and print it out as
       usual.

       Lines 2-7 are responsible for building the structure in the first
       place.  Here they are again:

	   2   while (<>) {
	   3	chomp;
	   4	 my ($city, $country) = split /, /;
	   5	 $table{$country} = [] unless exists $table{$country};
	   6	 push @{$table{$country}}, $city;
	   7   }

       Lines 2-4 acquire a city and country name.  Line 5 looks to see if the
       country is already present as a key in the hash.  If it's not, the pro-
       gram uses the "[]" notation (Make Rule 2) to manufacture a new, empty
       anonymous array of cities, and installs a reference to it into the hash
       under the appropriate key.

       Line 6 installs the city name into the appropriate array.  $ta-
       ble{$country} now holds a reference to the array of cities seen in that
       country so far.	Line 6 is exactly like

	       push @array, $city;

       except that the name "array" has been replaced by the reference "{$ta-
       ble{$country}}".  The "push" adds a city name to the end of the
       referred-to array.

       There's one fine point I skipped.  Line 5 is unnecessary, and we can
       get rid of it.

	   2   while (<>) {
	   3	chomp;
	   4	 my ($city, $country) = split /, /;
	   5   ####  $table{$country} = [] unless exists $table{$country};
	   6	 push @{$table{$country}}, $city;
	   7   }

       If there's already an entry in %table for the current $country, then
       nothing is different.  Line 6 will locate the value in $table{$coun-
       try}, which is a reference to an array, and push $city into the array.
       But what does it do when $country holds a key, say "Greece", that is
       not yet in %table?

       This is Perl, so it does the exact right thing.	It sees that you want
       to push "Athens" onto an array that doesn't exist, so it helpfully
       makes a new, empty, anonymous array for you, installs it into %table,
       and then pushes "Athens" onto it.  This is called `autovivifica-
       tion'--bringing things to life automatically.  Perl saw that they key
       wasn't in the hash, so it created a new hash entry automatically. Perl
       saw that you wanted to use the hash value as an array, so it created a
       new empty array and installed a reference to it in the hash automati-
       cally.  And as usual, Perl made the array one element longer to hold
       the new city name.

The Rest
       I promised to give you 90% of the benefit with 10% of the details, and
       that means I left out 90% of the details.  Now that you have an over-
       view of the important parts, it should be easier to read the perlref
       manual page, which discusses 100% of the details.

       Some of the highlights of perlref:

       o   You can make references to anything, including scalars, functions,
	   and other references.

       o   In Use Rule 1, you can omit the curly brackets whenever the thing
	   inside them is an atomic scalar variable like $aref.  For example,
	   @$aref is the same as "@{$aref}", and $$aref[1] is the same as
	   "${$aref}[1]".  If you're just starting out, you may want to adopt
	   the habit of always including the curly brackets.

       o   This doesn't copy the underlying array:

		   $aref2 = $aref1;

	   You get two references to the same array.  If you modify
	   "$aref1->[23]" and then look at "$aref2->[23]" you'll see the
	   change.

	   To copy the array, use

		   $aref2 = [@{$aref1}];

	   This uses "[...]" notation to create a new anonymous array, and
	   $aref2 is assigned a reference to the new array.  The new array is
	   initialized with the contents of the array referred to by $aref1.

	   Similarly, to copy an anonymous hash, you can use

		   $href2 = {%{$href1}};

       o   To see if a variable contains a reference, use the "ref" function.
	   It returns true if its argument is a reference.  Actually it's a
	   little better than that: It returns "HASH" for hash references and
	   "ARRAY" for array references.

       o   If you try to use a reference like a string, you get strings like

		   ARRAY(0x80f5dec)   or    HASH(0x826afc0)

	   If you ever see a string that looks like this, you'll know you
	   printed out a reference by mistake.

	   A side effect of this representation is that you can use "eq" to
	   see if two references refer to the same thing.  (But you should
	   usually use "==" instead because it's much faster.)

       o   You can use a string as if it were a reference.  If you use the
	   string "foo" as an array reference, it's taken to be a reference to
	   the array @foo.  This is called a soft reference or symbolic refer-
	   ence.  The declaration "use strict 'refs'" disables this feature,
	   which can cause all sorts of trouble if you use it by accident.

       You might prefer to go on to perllol instead of perlref; it discusses
       lists of lists and multidimensional arrays in detail.  After that, you
       should move on to perldsc; it's a Data Structure Cookbook that shows
       recipes for using and printing out arrays of hashes, hashes of arrays,
       and other kinds of data.

Summary
       Everyone needs compound data structures, and in Perl the way you get
       them is with references.  There are four important rules for managing
       references: Two for making references and two for using them.  Once you
       know these rules you can do most of the important things you need to do
       with references.

Credits
       Author: Mark Jason Dominus, Plover Systems ("mjd-perl-ref+@plover.com")

       This article originally appeared in The Perl Journal (
       http://www.tpj.com/ ) volume 3, #2.  Reprinted with permission.

       The original title was Understand References Today.

       Distribution Conditions

       Copyright 1998 The Perl Journal.

       This documentation is free; you can redistribute it and/or modify it
       under the same terms as Perl itself.

       Irrespective of its distribution, all code examples in these files are
       hereby placed into the public domain.  You are permitted and encouraged
       to use this code in your own programs for fun or for profit as you see
       fit.  A simple comment in the code giving credit would be courteous but
       is not required.



perl v5.8.8			  2006-01-07			 PERLREFTUT(1)
=19395
+713
(87)