/
usr
/
share
/
perl5
/
pod
/
/usr/share/perl5/pod
mkdir
upload
Name
Size
Mode
Actions
a2p.pod
6107
0644
edit
dl
rm
perl.pod
15748
0644
edit
dl
rm
perl56delta.pod
107184
0644
edit
dl
rm
perl58delta.pod
114908
0644
edit
dl
rm
perl561delta.pod
124697
0644
edit
dl
rm
perl570delta.pod
21655
0644
edit
dl
rm
perl571delta.pod
30382
0644
edit
dl
rm
perl572delta.pod
25551
0644
edit
dl
rm
perl573delta.pod
4644
0644
edit
dl
rm
perl581delta.pod
38060
0644
edit
dl
rm
perl582delta.pod
4470
0644
edit
dl
rm
perl583delta.pod
6335
0644
edit
dl
rm
perl584delta.pod
7363
0644
edit
dl
rm
perl585delta.pod
5889
0644
edit
dl
rm
perl586delta.pod
4651
0644
edit
dl
rm
perl587delta.pod
8357
0644
edit
dl
rm
perl588delta.pod
25267
0644
edit
dl
rm
perl589delta.pod
53905
0644
edit
dl
rm
perl590delta.pod
34951
0644
edit
dl
rm
perl591delta.pod
11173
0644
edit
dl
rm
perl592delta.pod
10954
0644
edit
dl
rm
perl593delta.pod
17034
0644
edit
dl
rm
perl594delta.pod
12661
0644
edit
dl
rm
perl595delta.pod
18934
0644
edit
dl
rm
perl5004delta.pod
56240
0644
edit
dl
rm
perl5005delta.pod
34285
0644
edit
dl
rm
perl5100delta.pod
53922
0644
edit
dl
rm
perl5101delta.pod
43877
0644
edit
dl
rm
perlaix.pod
18128
0644
edit
dl
rm
perlamiga.pod
7031
0644
edit
dl
rm
perlapi.pod
169428
0644
edit
dl
rm
perlapio.pod
19332
0644
edit
dl
rm
perlapollo.pod
829
0644
edit
dl
rm
perlartistic.pod
6802
0644
edit
dl
rm
perlbeos.pod
2939
0644
edit
dl
rm
perlbook.pod
663
0644
edit
dl
rm
perlboot.pod
28355
0644
edit
dl
rm
perlbot.pod
11675
0644
edit
dl
rm
perlbs2000.pod
7929
0644
edit
dl
rm
perlcall.pod
55173
0644
edit
dl
rm
perlce.pod
9257
0644
edit
dl
rm
perlcheat.pod
4153
0644
edit
dl
rm
perlclib.pod
7684
0644
edit
dl
rm
perlcn.pod
4915
0644
edit
dl
rm
perlcommunity.pod
6398
0644
edit
dl
rm
perlcompile.pod
9516
0644
edit
dl
rm
perlcygwin.pod
28183
0644
edit
dl
rm
perldata.pod
36879
0644
edit
dl
rm
perldbmfilter.pod
4987
0644
edit
dl
rm
perldebguts.pod
31887
0644
edit
dl
rm
perldebtut.pod
21304
0644
edit
dl
rm
perldebug.pod
37535
0644
edit
dl
rm
perldelta.pod
43877
0644
edit
dl
rm
perldgux.pod
2821
0644
edit
dl
rm
perldiag.pod
183151
0644
edit
dl
rm
perldoc.pod
7310
0644
edit
dl
rm
perldos.pod
10853
0644
edit
dl
rm
perldsc.pod
25447
0644
edit
dl
rm
perlebcdic.pod
66607
0644
edit
dl
rm
perlembed.pod
38033
0644
edit
dl
rm
perlepoc.pod
3779
0644
edit
dl
rm
perlfaq.pod
24841
0644
edit
dl
rm
perlfaq1.pod
17762
0644
edit
dl
rm
perlfaq2.pod
21614
0644
edit
dl
rm
perlfaq3.pod
38534
0644
edit
dl
rm
perlfaq4.pod
81412
0644
edit
dl
rm
perlfaq5.pod
49201
0644
edit
dl
rm
perlfaq6.pod
38538
0644
edit
dl
rm
perlfaq7.pod
37588
0644
edit
dl
rm
perlfaq8.pod
46128
0644
edit
dl
rm
perlfaq9.pod
24191
0644
edit
dl
rm
perlfilter.pod
21140
0644
edit
dl
rm
perlfork.pod
11440
0644
edit
dl
rm
perlform.pod
16894
0644
edit
dl
rm
perlfreebsd.pod
1950
0644
edit
dl
rm
perlfunc.pod
291909
0644
edit
dl
rm
perlglossary.pod
112139
0644
edit
dl
rm
perlgpl.pod
18806
0644
edit
dl
rm
perlguts.pod
105182
0644
edit
dl
rm
perlhack.pod
121512
0644
edit
dl
rm
perlhaiku.pod
1504
0644
edit
dl
rm
perlhist.pod
38766
0644
edit
dl
rm
perlhpux.pod
28650
0644
edit
dl
rm
perlhurd.pod
1990
0644
edit
dl
rm
perlintern.pod
26408
0644
edit
dl
rm
perlintro.pod
21491
0644
edit
dl
rm
perliol.pod
33755
0644
edit
dl
rm
perlipc.pod
67761
0644
edit
dl
rm
perlirix.pod
4397
0644
edit
dl
rm
perljp.pod
8070
0644
edit
dl
rm
perlko.pod
7892
0644
edit
dl
rm
perllexwarn.pod
14435
0644
edit
dl
rm
perllinux.pod
1492
0644
edit
dl
rm
perllocale.pod
41616
0644
edit
dl
rm
perllol.pod
8252
0644
edit
dl
rm
perlmachten.pod
4500
0644
edit
dl
rm
perlmacos.pod
2111
0644
edit
dl
rm
perlmacosx.pod
11322
0644
edit
dl
rm
perlmint.pod
9539
0644
edit
dl
rm
perlmod.pod
24494
0644
edit
dl
rm
perlmodinstall.pod
13929
0644
edit
dl
rm
perlmodlib.pod
77333
0644
edit
dl
rm
perlmodstyle.pod
21114
0644
edit
dl
rm
perlmpeix.pod
15087
0644
edit
dl
rm
perlmroapi.pod
2959
0644
edit
dl
rm
perlnetware.pod
6488
0644
edit
dl
rm
perlnewmod.pod
11214
0644
edit
dl
rm
perlnumber.pod
8352
0644
edit
dl
rm
perlobj.pod
21813
0644
edit
dl
rm
perlop.pod
96225
0644
edit
dl
rm
perlopenbsd.pod
1207
0644
edit
dl
rm
perlopentut.pod
37997
0644
edit
dl
rm
perlos2.pod
92783
0644
edit
dl
rm
perlos390.pod
16074
0644
edit
dl
rm
perlos400.pod
4618
0644
edit
dl
rm
perlothrtut.pod
40657
0644
edit
dl
rm
perlpacktut.pod
51047
0644
edit
dl
rm
perlperf.pod
51328
0644
edit
dl
rm
perlplan9.pod
5125
0644
edit
dl
rm
perlpod.pod
21626
0644
edit
dl
rm
perlpodspec.pod
67792
0644
edit
dl
rm
perlport.pod
86302
0644
edit
dl
rm
perlpragma.pod
4320
0644
edit
dl
rm
perlqnx.pod
4246
0644
edit
dl
rm
perlre.pod
82798
0644
edit
dl
rm
perlreapi.pod
25427
0644
edit
dl
rm
perlrebackslash.pod
20109
0644
edit
dl
rm
perlrecharclass.pod
21909
0644
edit
dl
rm
perlref.pod
26465
0644
edit
dl
rm
perlreftut.pod
18670
0644
edit
dl
rm
perlreguts.pod
36877
0644
edit
dl
rm
perlrepository.pod
23453
0644
edit
dl
rm
perlrequick.pod
17617
0644
edit
dl
rm
perlreref.pod
11996
0644
edit
dl
rm
perlretut.pod
115005
0644
edit
dl
rm
perlriscos.pod
1511
0644
edit
dl
rm
perlrun.pod
49928
0644
edit
dl
rm
perlsec.pod
23542
0644
edit
dl
rm
perlsolaris.pod
29131
0644
edit
dl
rm
perlstyle.pod
8618
0644
edit
dl
rm
perlsub.pod
54222
0644
edit
dl
rm
perlsymbian.pod
16222
0644
edit
dl
rm
perlsyn.pod
31090
0644
edit
dl
rm
perlthrtut.pod
46510
0644
edit
dl
rm
perltie.pod
36665
0644
edit
dl
rm
perltoc.pod
642987
0644
edit
dl
rm
perltodo.pod
48360
0644
edit
dl
rm
perltooc.pod
51425
0644
edit
dl
rm
perltoot.pod
68625
0644
edit
dl
rm
perltrap.pod
41151
0644
edit
dl
rm
perltru64.pod
7736
0644
edit
dl
rm
perltw.pod
5384
0644
edit
dl
rm
perlunicode.pod
56169
0644
edit
dl
rm
perlunifaq.pod
12878
0644
edit
dl
rm
perluniintro.pod
32973
0644
edit
dl
rm
perlunitut.pod
7907
0644
edit
dl
rm
perlutil.pod
9881
0644
edit
dl
rm
perluts.pod
3180
0644
edit
dl
rm
perlvar.pod
59133
0644
edit
dl
rm
perlvmesa.pod
3952
0644
edit
dl
rm
perlvms.pod
52545
0644
edit
dl
rm
perlvos.pod
5567
0644
edit
dl
rm
perlwin32.pod
40809
0644
edit
dl
rm
perlxs.pod
74194
0644
edit
dl
rm
perlxstut.pod
49670
0644
edit
dl
rm
Edit:
/usr/share/perl5/pod/perlreftut.pod
(18670B)
=head1 NAME perlreftut - Mark's very short tutorial about references =head1 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%. =head1 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 mentioned once, and then an alphabetical list of the cities in that country: 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. =head1 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 references. A reference is a scalar value that I<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 "Barack Obama". 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 "Barack Obama", 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. =head1 Syntax There are just two ways to make a reference, and just two ways to use it once you have it. =head2 Making References =head3 B<Make Rule 1> If you put a C<\> 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 C<"\n"> or the number 80 without having to store it in a named variable first. B<Make Rule 2> C<[ ITEMS ]> makes a new, anonymous array, and returns a reference to that array. C<{ 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 C<@array>. If you write just C<[]>, you get a new, empty anonymous array. If you write just C<{}>, you get a new, empty anonymous hash. =head2 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: =head3 B<Use Rule 1> You can always use an array reference, in curly braces, in place of the name of an array. For example, C<@{$aref}> instead of C<@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 C<@a>. The right-hand versions operate on the array that is referred to by C<$aref>. Once they find the array they're operating on, both versions do the same things to the arrays. Using a hash reference is I<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, B<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 C<{$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, C<@array>, with the reference: for my $element (@{$aref}) { ... } "How do I print out the contents of a hash when all I have is a reference?" 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"; } =head3 B<Use Rule 2> B<Use Rule 1> is all you really need, because it tells you how to do absolutely 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 element, and the B<Use Rule 1> notation is cumbersome. So there is an abbreviation. C<${$aref}[3]> is too hard to read, so you can write C<< $aref->[3] >> instead. C<${$href}{red}> is too hard to read, so you can write C<< $href->{red} >> instead. If C<$aref> holds a reference to an array, then C<< $aref->[3] >> is the fourth element of the array. Don't confuse this with C<$aref[3]>, which is the fourth element of a totally different array, one deceptively named C<@aref>. C<$aref> and C<@aref> are unrelated the same way that C<$item> and C<@item> are. Similarly, C<< $href->{'red'} >> is part of the hash referred to by the scalar variable C<$href>, perhaps even one with no name. C<$href{'red'}> is part of the deceptively named C<%href> hash. It's easy to forget to leave out the C<< -> >>, and if you do, you'll get bizarre results when your program gets array and hash elements out of totally unexpected hashes and arrays that weren't the ones you wanted to use. =head2 An Example Let's see a quick example of how all this is useful. First, remember that C<[1, 2, 3]> makes an anonymous array containing C<(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. C<$a[1]> is one of these references. It refers to an array, the array containing C<(4, 5, 6)>, and because it is a reference to an array, B<Use Rule 2> says that we can write C<< $a[1]->[2] >> to get the third element from that array. C<< $a[1]->[2] >> is the 6. Similarly, C<< $a[0]->[1] >> is the 2. What we have here is like a two-dimensional array; you can write C<< $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: =head2 Arrow Rule In between two B<subscripts>, the arrow is optional. Instead of C<< $a[1]->[2] >>, we can write C<$a[1][2]>; it means the same thing. Instead of C<< $a[0]->[1] = 23 >>, we can write C<$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 C<${$a[1]}[2]> instead of C<$a[1][2]>. For three-dimensional arrays, they let us write C<$x[2][3][5]> instead of the unreadable C<${${$x[2]}[3]}[5]>. =head1 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, C<%table>, whose keys are country names, and whose values are references to arrays of city names. The data structure 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 } C<%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. C<$table{$country}> looks up the key C<$country> in the hash and gets the value, which is a reference to an array of cities in that country. B<Use Rule 1> says that we can recover the array by saying C<@{$table{$country}}>. Line 10 is just like @cities = @array; except that the name C<array> has been replaced by the reference C<{$table{$country}}>. The C<@> 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 program uses the C<[]> notation (B<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. C<$table{$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 C<array> has been replaced by the reference C<{$table{$country}}>. The C<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 C<%table> for the current C<$country>, then nothing is different. Line 6 will locate the value in C<$table{$country}>, which is a reference to an array, and push C<$city> into the array. But what does it do when C<$country> holds a key, say C<Greece>, that is not yet in C<%table>? This is Perl, so it does the exact right thing. It sees that you want to push C<Athens> onto an array that doesn't exist, so it helpfully makes a new, empty, anonymous array for you, installs it into C<%table>, and then pushes C<Athens> onto it. This is called `autovivification'--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 automatically. And as usual, Perl made the array one element longer to hold the new city name. =head1 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 overview of the important parts, it should be easier to read the L<perlref> manual page, which discusses 100% of the details. Some of the highlights of L<perlref>: =over 4 =item * You can make references to anything, including scalars, functions, and other references. =item * In B<Use Rule 1>, you can omit the curly brackets whenever the thing inside them is an atomic scalar variable like C<$aref>. For example, C<@$aref> is the same as C<@{$aref}>, and C<$$aref[1]> is the same as C<${$aref}[1]>. If you're just starting out, you may want to adopt the habit of always including the curly brackets. =item * This doesn't copy the underlying array: $aref2 = $aref1; You get two references to the same array. If you modify C<< $aref1->[23] >> and then look at C<< $aref2->[23] >> you'll see the change. To copy the array, use $aref2 = [@{$aref1}]; This uses C<[...]> notation to create a new anonymous array, and C<$aref2> is assigned a reference to the new array. The new array is initialized with the contents of the array referred to by C<$aref1>. Similarly, to copy an anonymous hash, you can use $href2 = {%{$href1}}; =item * To see if a variable contains a reference, use the C<ref> function. It returns true if its argument is a reference. Actually it's a little better than that: It returns C<HASH> for hash references and C<ARRAY> for array references. =item * 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 C<eq> to see if two references refer to the same thing. (But you should usually use C<==> instead because it's much faster.) =item * You can use a string as if it were a reference. If you use the string C<"foo"> as an array reference, it's taken to be a reference to the array C<@foo>. This is called a I<soft reference> or I<symbolic reference>. The declaration C<use strict 'refs'> disables this feature, which can cause all sorts of trouble if you use it by accident. =back You might prefer to go on to L<perllol> instead of L<perlref>; it discusses lists of lists and multidimensional arrays in detail. After that, you should move on to L<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. =head1 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. =head1 Credits Author: Mark Jason Dominus, Plover Systems (C<mjd-perl-ref+@plover.com>) This article originally appeared in I<The Perl Journal> ( http://www.tpj.com/ ) volume 3, #2. Reprinted with permission. The original title was I<Understand References Today>. =head2 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. =cut
Save
cmd:
run