Use 'sudo' to run root-level commands
[catagits/Catalyst-Manual.git] / lib / Catalyst / Manual / Tutorial / 01_Intro.pod
index e99baa1..00c7c0c 100644 (file)
@@ -193,15 +193,12 @@ Virtual Machine.  This document uses the term "host machine" to refer to
 the physical machine where you will run the virtualization software and
 boot up the VM.  The terms "guest machine" or just "VM" refer to the
 virtual machine itself -- the thing where you actually do the tutorial
-and that you boot up on the "host machine".
+(and that you boot up on the "host machine").
 
-Also, to reduce download size, the Tutorial VM just includes a minimal
-command-line environment.  In general, it is expected that people will
-boot up the Tutorial VM on their main desktop (the "host machine" using
-the terminology above) and then use that main desktop machine to SSH and
-web browse into the "guest VM" as they work through the tutorial.  If
-you wish to install X-Windows (or any other packages), just use the
-C<aptitude> (or C<apt-get>) Debian commands.
+B<Note:> Throughout the tutorial, we will shows the UNIX shell prompt as
+"C<$>".  If you are using the Tutorial VM, the prompt will really be
+"C<catalyst@catalyst:~$>" (where "C<~"> will change to show your
+current directory), but we will keep it short and just use "C<$>".
 
 
 =over 4
@@ -216,9 +213,9 @@ B<(and everything else they do for the Perl community)!>
 
 =item 2
 
-Uncompress the image:
+Uncompress the image on the "host machine":
 
-    tar zxvf CatalystTutorial.tgz
+    MAINCOMPUTER:~$ tar zxvf CatalystTutorial.tgz
 
 =item 3
 
@@ -228,13 +225,14 @@ L<http://www.virtualbox.org/>.
 
 =item 4
 
-Once you get a login prompt, enter the username B<root> and a password
-for C<catalyst>.  You should now be at a prompt that looks like:
+Once you get a login prompt, enter the username B<catalyst> and a
+password for C<catalyst>.  You should now be at a prompt that looks
+like:
 
-    catalyst login: root
+    catalyst login: catalyst
     Password: catalyst
     ...
-    root@catalyst:~#
+    catalyst@catalyst:~$
 
 =item 5
 
@@ -252,7 +250,7 @@ The image it design to automatically use a DHCP-assigned address.
 Try to ping this IP address from your "host machine" (main desktop):
 
 
-    MainComputer:~$ ping 192.168.0.12
+    MAINCOMPUTER:~$ ping 192.168.0.12
     PING 192.168.0.12 (192.168.0.12) 56(84) bytes of data.
     64 bytes from 192.168.0.12: icmp_req=1 ttl=255 time=4.97 ms
     64 bytes from 192.168.0.12: icmp_req=2 ttl=255 time=3.43 ms
@@ -279,13 +277,13 @@ tutorial.
 B<From your main desktop machine>, open an SSH client and connect to the
 IP address found in the previous step.  You should get a login prompt
 (accept the SSH key if you get a warning message about that).  Login
-with the same username and password as we used in Step 4: B<root> /
+with the same username and password as we used in Step 4: B<catalyst> /
 B<catalyst>
 
-    catalyst login: root
+    catalyst login: catalyst
     Password: catalyst
     ...
-    root@catalyst:~#
+    catalyst@catalyst:~$
 
 
 =item 7
@@ -317,26 +315,60 @@ back and carefully check each of the steps above.
 
 =item 9
 
-B<Optional:> The VI/VIM editor is already installed on the Tutorial
-Virtual Machine.  In order to reduce the size of the download, Emacs is
-not pre-installed.  Since people obviously have very strong opinions
-about which editor is best, :-) Debian fortunately make it very easy to
-install Emacs:
+B<Optional:> Also, to reduce download size, the Tutorial VM just
+includes a minimal command-line environment.  You are free to use
+Debian's very capable C<apt> package manager to install other packages.
+You will first want to pull the apt cache files with C<aptitude update>
+(or C<apt-get update> if you prefer apt-get).
+
+The VI/VIM editor is already installed on the Tutorial Virtual Machine.
+In order to reduce the size of the download, Emacs is not pre-installed.
+Since people obviously have very strong opinions about which editor is
+best, :-) fortunately it's very easy to install Emacs:
+
+    $ sudo aptitude update
+    $ sudo aptitude install emacs
+
+In general, it is expected that people will
+boot up the Tutorial VM on their main desktop (the "host machine" using
+the terminology above) and then use that main desktop machine to SSH and
+web browse into the "guest VM" as they work through the tutorial.  If
+you wish to install X Windows (or any other packages), just use the
+C<aptitude> (or C<apt-get>) Debian commands.  For example, to install
+X Windows with the Gnome desktop manager, you can do:
+
+    $ sudo aptitude update
+    $ sudo ptitude install gnome iceweasel
+
+Or, if you prefer KDE:
+
+    $ sudo aptitude update
+    $ sudo aptitude install kde iceweasel
+
+You can then start X Windows with:
+
+    $ startx
 
-    $ aptitude install emacs
 
 =back
 
 
 You may note that the Tutorial Virtual Machine uses L<local::lib> so
-that the Perl modules are run from ~/perl5 (in this case, /root/perl5)
-vs. the usual location of your "system Perl".  We recommend that you
-also consider using this very handy module.  It can greatly ease the
-process of maintaining and testing different combinations or Perl
-modules across development, staging, and production servers.  (The
-"relocatable Perl" feature can also be used to to run both the modules
-B<and> Perl itself from your home directory [or any other directory you
-chose]).
+that the Perl modules are run from ~/perl5 (in this case,
+/home/catalyst/perl5) vs. the usual location of your "system Perl".  We
+recommend that you also consider using this very handy module.  It can
+greatly ease the process of maintaining and testing different
+combinations or Perl modules across development, staging, and production
+servers.  (The "relocatable Perl" feature can also be used to to run
+both the modules B<and> Perl itself from your home directory [or any
+other directory you chose]).
+
+B<Note>: Please provide feedback on how the Virtual Machine approach for
+the tutorial works for you.  If you have suggestions or comments, you
+can reach the author through the email address at the bottom of this
+page or via an RT ticket at
+L<https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Manual>.
+
 
 
 =head2 Sorting Out Virtual Machine Network-Related Issues
@@ -511,10 +543,10 @@ L<Catalyst Basics|Catalyst::Manual::Tutorial::02_CatalystBasics>
 
 Kennedy Clark, C<hkclark@gmail.com>
 
-Please report any errors, issues or suggestions to the author.  The
-most recent version of the Catalyst Tutorial can be found at
-L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.80/trunk/lib/Catalyst/Manual/Tutorial/>.
+Feel free to contact the author for any errors or suggestions, but the
+best way to report issues is via the CPAN RT Bug system at
+L<https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Manual>.
 
-Copyright 2006-2010, Kennedy Clark, under the
+Copyright 2006-2011, Kennedy Clark, under the
 Creative Commons Attribution Share-Alike License Version 3.0
 (L<http://creativecommons.org/licenses/by-sa/3.0/us/>).