Integrate perlio:
[p5sagit/p5-mst-13.2.git] / pod / perlfaq8.pod
1 =head1 NAME
2
3 perlfaq8 - System Interaction ($Revision: 1.6 $, $Date: 2002/01/28 04:17:27 $)
4
5 =head1 DESCRIPTION
6
7 This section of the Perl FAQ covers questions involving operating
8 system interaction.  Topics include interprocess communication (IPC),
9 control over the user-interface (keyboard, screen and pointing
10 devices), and most anything else not related to data manipulation.
11
12 Read the FAQs and documentation specific to the port of perl to your
13 operating system (eg, L<perlvms>, L<perlplan9>, ...).  These should
14 contain more detailed information on the vagaries of your perl.
15
16 =head2 How do I find out which operating system I'm running under?
17
18 The $^O variable ($OSNAME if you use English) contains an indication of
19 the name of the operating system (not its release number) that your perl
20 binary was built for.
21
22 =head2 How come exec() doesn't return?
23
24 Because that's what it does: it replaces your currently running
25 program with a different one.  If you want to keep going (as is
26 probably the case if you're asking this question) use system()
27 instead.
28
29 =head2 How do I do fancy stuff with the keyboard/screen/mouse?
30
31 How you access/control keyboards, screens, and pointing devices
32 ("mice") is system-dependent.  Try the following modules:
33
34 =over 4
35
36 =item Keyboard
37
38     Term::Cap                   Standard perl distribution
39     Term::ReadKey               CPAN
40     Term::ReadLine::Gnu         CPAN
41     Term::ReadLine::Perl        CPAN
42     Term::Screen                CPAN
43
44 =item Screen
45
46     Term::Cap                   Standard perl distribution
47     Curses                      CPAN
48     Term::ANSIColor             CPAN
49
50 =item Mouse
51
52     Tk                          CPAN
53
54 =back
55
56 Some of these specific cases are shown below.
57
58 =head2 How do I print something out in color?
59
60 In general, you don't, because you don't know whether
61 the recipient has a color-aware display device.  If you
62 know that they have an ANSI terminal that understands
63 color, you can use the Term::ANSIColor module from CPAN:
64
65     use Term::ANSIColor;
66     print color("red"), "Stop!\n", color("reset");
67     print color("green"), "Go!\n", color("reset");
68
69 Or like this:
70
71     use Term::ANSIColor qw(:constants);
72     print RED, "Stop!\n", RESET;
73     print GREEN, "Go!\n", RESET;
74
75 =head2 How do I read just one key without waiting for a return key?
76
77 Controlling input buffering is a remarkably system-dependent matter.
78 On many systems, you can just use the B<stty> command as shown in
79 L<perlfunc/getc>, but as you see, that's already getting you into
80 portability snags.  
81
82     open(TTY, "+</dev/tty") or die "no tty: $!";
83     system "stty  cbreak </dev/tty >/dev/tty 2>&1";
84     $key = getc(TTY);           # perhaps this works
85     # OR ELSE
86     sysread(TTY, $key, 1);      # probably this does
87     system "stty -cbreak </dev/tty >/dev/tty 2>&1";
88
89 The Term::ReadKey module from CPAN offers an easy-to-use interface that
90 should be more efficient than shelling out to B<stty> for each key.
91 It even includes limited support for Windows.
92
93     use Term::ReadKey;
94     ReadMode('cbreak');
95     $key = ReadKey(0);
96     ReadMode('normal');
97
98 However, using the code requires that you have a working C compiler
99 and can use it to build and install a CPAN module.  Here's a solution
100 using the standard POSIX module, which is already on your systems
101 (assuming your system supports POSIX).
102
103     use HotKey;
104     $key = readkey();
105
106 And here's the HotKey module, which hides the somewhat mystifying calls
107 to manipulate the POSIX termios structures.
108
109     # HotKey.pm
110     package HotKey;
111
112     @ISA = qw(Exporter);
113     @EXPORT = qw(cbreak cooked readkey);
114
115     use strict;
116     use POSIX qw(:termios_h);
117     my ($term, $oterm, $echo, $noecho, $fd_stdin);
118
119     $fd_stdin = fileno(STDIN);
120     $term     = POSIX::Termios->new();
121     $term->getattr($fd_stdin);
122     $oterm     = $term->getlflag();
123
124     $echo     = ECHO | ECHOK | ICANON;
125     $noecho   = $oterm & ~$echo;
126
127     sub cbreak {
128         $term->setlflag($noecho);  # ok, so i don't want echo either
129         $term->setcc(VTIME, 1);
130         $term->setattr($fd_stdin, TCSANOW);
131     }
132
133     sub cooked {
134         $term->setlflag($oterm);
135         $term->setcc(VTIME, 0);
136         $term->setattr($fd_stdin, TCSANOW);
137     }
138
139     sub readkey {
140         my $key = '';
141         cbreak();
142         sysread(STDIN, $key, 1);
143         cooked();
144         return $key;
145     }
146
147     END { cooked() }
148
149     1;
150
151 =head2 How do I check whether input is ready on the keyboard?
152
153 The easiest way to do this is to read a key in nonblocking mode with the
154 Term::ReadKey module from CPAN, passing it an argument of -1 to indicate
155 not to block:
156
157     use Term::ReadKey;
158
159     ReadMode('cbreak');
160
161     if (defined ($char = ReadKey(-1)) ) {
162         # input was waiting and it was $char
163     } else {
164         # no input was waiting
165     }
166
167     ReadMode('normal');                  # restore normal tty settings
168
169 =head2 How do I clear the screen?
170
171 If you only have do so infrequently, use C<system>:
172
173     system("clear");
174
175 If you have to do this a lot, save the clear string
176 so you can print it 100 times without calling a program
177 100 times:
178
179     $clear_string = `clear`;
180     print $clear_string;
181
182 If you're planning on doing other screen manipulations, like cursor
183 positions, etc, you might wish to use Term::Cap module:
184
185     use Term::Cap;
186     $terminal = Term::Cap->Tgetent( {OSPEED => 9600} );
187     $clear_string = $terminal->Tputs('cl');
188
189 =head2 How do I get the screen size?
190
191 If you have Term::ReadKey module installed from CPAN, 
192 you can use it to fetch the width and height in characters
193 and in pixels:
194
195     use Term::ReadKey;
196     ($wchar, $hchar, $wpixels, $hpixels) = GetTerminalSize();
197
198 This is more portable than the raw C<ioctl>, but not as 
199 illustrative:
200
201     require 'sys/ioctl.ph';
202     die "no TIOCGWINSZ " unless defined &TIOCGWINSZ;
203     open(TTY, "+</dev/tty")                     or die "No tty: $!";
204     unless (ioctl(TTY, &TIOCGWINSZ, $winsize='')) {
205         die sprintf "$0: ioctl TIOCGWINSZ (%08x: $!)\n", &TIOCGWINSZ;
206     }
207     ($row, $col, $xpixel, $ypixel) = unpack('S4', $winsize);
208     print "(row,col) = ($row,$col)";
209     print "  (xpixel,ypixel) = ($xpixel,$ypixel)" if $xpixel || $ypixel;
210     print "\n";
211
212 =head2 How do I ask the user for a password?
213
214 (This question has nothing to do with the web.  See a different
215 FAQ for that.)
216
217 There's an example of this in L<perlfunc/crypt>).  First, you put the
218 terminal into "no echo" mode, then just read the password normally.
219 You may do this with an old-style ioctl() function, POSIX terminal
220 control (see L<POSIX> or its documentation the Camel Book), or a call
221 to the B<stty> program, with varying degrees of portability.
222
223 You can also do this for most systems using the Term::ReadKey module
224 from CPAN, which is easier to use and in theory more portable.
225
226     use Term::ReadKey;
227
228     ReadMode('noecho');
229     $password = ReadLine(0);
230
231 =head2 How do I read and write the serial port?
232
233 This depends on which operating system your program is running on.  In
234 the case of Unix, the serial ports will be accessible through files in
235 /dev; on other systems, device names will doubtless differ.
236 Several problem areas common to all device interaction are the
237 following:
238
239 =over 4
240
241 =item lockfiles
242
243 Your system may use lockfiles to control multiple access.  Make sure
244 you follow the correct protocol.  Unpredictable behavior can result
245 from multiple processes reading from one device.
246
247 =item open mode
248
249 If you expect to use both read and write operations on the device,
250 you'll have to open it for update (see L<perlfunc/"open"> for
251 details).  You may wish to open it without running the risk of
252 blocking by using sysopen() and C<O_RDWR|O_NDELAY|O_NOCTTY> from the
253 Fcntl module (part of the standard perl distribution).  See
254 L<perlfunc/"sysopen"> for more on this approach.
255
256 =item end of line
257
258 Some devices will be expecting a "\r" at the end of each line rather
259 than a "\n".  In some ports of perl, "\r" and "\n" are different from
260 their usual (Unix) ASCII values of "\012" and "\015".  You may have to
261 give the numeric values you want directly, using octal ("\015"), hex
262 ("0x0D"), or as a control-character specification ("\cM").
263
264     print DEV "atv1\012";       # wrong, for some devices
265     print DEV "atv1\015";       # right, for some devices
266
267 Even though with normal text files a "\n" will do the trick, there is
268 still no unified scheme for terminating a line that is portable
269 between Unix, DOS/Win, and Macintosh, except to terminate I<ALL> line
270 ends with "\015\012", and strip what you don't need from the output.
271 This applies especially to socket I/O and autoflushing, discussed
272 next.
273
274 =item flushing output
275
276 If you expect characters to get to your device when you print() them,
277 you'll want to autoflush that filehandle.  You can use select()
278 and the C<$|> variable to control autoflushing (see L<perlvar/$|>
279 and L<perlfunc/select>, or L<perlfaq5>, ``How do I flush/unbuffer an
280 output filehandle?  Why must I do this?''):
281
282     $oldh = select(DEV);
283     $| = 1;
284     select($oldh);
285
286 You'll also see code that does this without a temporary variable, as in
287
288     select((select(DEV), $| = 1)[0]);
289
290 Or if you don't mind pulling in a few thousand lines
291 of code just because you're afraid of a little $| variable:
292
293     use IO::Handle;
294     DEV->autoflush(1);
295
296 As mentioned in the previous item, this still doesn't work when using
297 socket I/O between Unix and Macintosh.  You'll need to hard code your
298 line terminators, in that case.
299
300 =item non-blocking input
301
302 If you are doing a blocking read() or sysread(), you'll have to
303 arrange for an alarm handler to provide a timeout (see
304 L<perlfunc/alarm>).  If you have a non-blocking open, you'll likely
305 have a non-blocking read, which means you may have to use a 4-arg
306 select() to determine whether I/O is ready on that device (see
307 L<perlfunc/"select">.
308
309 =back
310
311 While trying to read from his caller-id box, the notorious Jamie Zawinski
312 <jwz@netscape.com>, after much gnashing of teeth and fighting with sysread,
313 sysopen, POSIX's tcgetattr business, and various other functions that
314 go bump in the night, finally came up with this:
315
316     sub open_modem {
317         use IPC::Open2;
318         my $stty = `/bin/stty -g`;
319         open2( \*MODEM_IN, \*MODEM_OUT, "cu -l$modem_device -s2400 2>&1");
320         # starting cu hoses /dev/tty's stty settings, even when it has
321         # been opened on a pipe...
322         system("/bin/stty $stty");
323         $_ = <MODEM_IN>;
324         chomp;
325         if ( !m/^Connected/ ) {
326             print STDERR "$0: cu printed `$_' instead of `Connected'\n";
327         }
328     }
329
330 =head2 How do I decode encrypted password files?
331
332 You spend lots and lots of money on dedicated hardware, but this is
333 bound to get you talked about.
334
335 Seriously, you can't if they are Unix password files--the Unix
336 password system employs one-way encryption.  It's more like hashing than
337 encryption.  The best you can check is whether something else hashes to
338 the same string.  You can't turn a hash back into the original string.
339 Programs like Crack
340 can forcibly (and intelligently) try to guess passwords, but don't
341 (can't) guarantee quick success.
342
343 If you're worried about users selecting bad passwords, you should
344 proactively check when they try to change their password (by modifying
345 passwd(1), for example).
346
347 =head2 How do I start a process in the background?
348
349 You could use
350
351     system("cmd &")
352
353 or you could use fork as documented in L<perlfunc/"fork">, with
354 further examples in L<perlipc>.  Some things to be aware of, if you're
355 on a Unix-like system:
356
357 =over 4
358
359 =item STDIN, STDOUT, and STDERR are shared
360
361 Both the main process and the backgrounded one (the "child" process)
362 share the same STDIN, STDOUT and STDERR filehandles.  If both try to
363 access them at once, strange things can happen.  You may want to close
364 or reopen these for the child.  You can get around this with
365 C<open>ing a pipe (see L<perlfunc/"open">) but on some systems this
366 means that the child process cannot outlive the parent.
367
368 =item Signals
369
370 You'll have to catch the SIGCHLD signal, and possibly SIGPIPE too.
371 SIGCHLD is sent when the backgrounded process finishes.  SIGPIPE is
372 sent when you write to a filehandle whose child process has closed (an
373 untrapped SIGPIPE can cause your program to silently die).  This is
374 not an issue with C<system("cmd&")>.
375
376 =item Zombies
377
378 You have to be prepared to "reap" the child process when it finishes
379
380     $SIG{CHLD} = sub { wait };
381
382 See L<perlipc/"Signals"> for other examples of code to do this.
383 Zombies are not an issue with C<system("prog &")>.
384
385 =back
386
387 =head2 How do I trap control characters/signals?
388
389 You don't actually "trap" a control character.  Instead, that character
390 generates a signal which is sent to your terminal's currently
391 foregrounded process group, which you then trap in your process.
392 Signals are documented in L<perlipc/"Signals"> and the
393 section on ``Signals'' in the Camel.
394
395 Be warned that very few C libraries are re-entrant.  Therefore, if you
396 attempt to print() in a handler that got invoked during another stdio
397 operation your internal structures will likely be in an
398 inconsistent state, and your program will dump core.  You can
399 sometimes avoid this by using syswrite() instead of print().
400
401 Unless you're exceedingly careful, the only safe things to do inside a
402 signal handler are (1) set a variable and (2) exit.  In the first case,
403 you should only set a variable in such a way that malloc() is not
404 called (eg, by setting a variable that already has a value).
405
406 For example:
407
408     $Interrupted = 0;   # to ensure it has a value
409     $SIG{INT} = sub {
410         $Interrupted++;
411         syswrite(STDERR, "ouch\n", 5);
412     }
413
414 However, because syscalls restart by default, you'll find that if
415 you're in a "slow" call, such as <FH>, read(), connect(), or
416 wait(), that the only way to terminate them is by "longjumping" out;
417 that is, by raising an exception.  See the time-out handler for a
418 blocking flock() in L<perlipc/"Signals"> or the section on ``Signals''
419 in the Camel book.
420
421 =head2 How do I modify the shadow password file on a Unix system?
422
423 If perl was installed correctly and your shadow library was written
424 properly, the getpw*() functions described in L<perlfunc> should in
425 theory provide (read-only) access to entries in the shadow password
426 file.  To change the file, make a new shadow password file (the format
427 varies from system to system--see L<passwd(5)> for specifics) and use
428 pwd_mkdb(8) to install it (see L<pwd_mkdb(8)> for more details).
429
430 =head2 How do I set the time and date?
431
432 Assuming you're running under sufficient permissions, you should be
433 able to set the system-wide date and time by running the date(1)
434 program.  (There is no way to set the time and date on a per-process
435 basis.)  This mechanism will work for Unix, MS-DOS, Windows, and NT;
436 the VMS equivalent is C<set time>.
437
438 However, if all you want to do is change your time zone, you can
439 probably get away with setting an environment variable:
440
441     $ENV{TZ} = "MST7MDT";                  # unixish
442     $ENV{'SYS$TIMEZONE_DIFFERENTIAL'}="-5" # vms
443     system "trn comp.lang.perl.misc";
444
445 =head2 How can I sleep() or alarm() for under a second?
446
447 If you want finer granularity than the 1 second that the sleep()
448 function provides, the easiest way is to use the select() function as
449 documented in L<perlfunc/"select">.  Try the Time::HiRes and
450 the BSD::Itimer modules (available from CPAN, and starting from
451 Perl 5.8 Time::HiRes is part of the standard distribution).
452
453 =head2 How can I measure time under a second?
454
455 In general, you may not be able to.  The Time::HiRes module (available
456 from CPAN, and starting from Perl 5.8 part of the standard distribution)
457 provides this functionality for some systems.
458
459 If your system supports both the syscall() function in Perl as well as
460 a system call like gettimeofday(2), then you may be able to do
461 something like this:
462
463     require 'sys/syscall.ph';
464
465     $TIMEVAL_T = "LL";
466
467     $done = $start = pack($TIMEVAL_T, ());
468
469     syscall(&SYS_gettimeofday, $start, 0) != -1
470                or die "gettimeofday: $!";
471
472        ##########################
473        # DO YOUR OPERATION HERE #
474        ##########################
475
476     syscall( &SYS_gettimeofday, $done, 0) != -1
477            or die "gettimeofday: $!";
478
479     @start = unpack($TIMEVAL_T, $start);
480     @done  = unpack($TIMEVAL_T, $done);
481
482     # fix microseconds
483     for ($done[1], $start[1]) { $_ /= 1_000_000 }
484
485     $delta_time = sprintf "%.4f", ($done[0]  + $done[1]  )
486                                             -
487                                  ($start[0] + $start[1] );
488
489 =head2 How can I do an atexit() or setjmp()/longjmp()? (Exception handling)
490
491 Release 5 of Perl added the END block, which can be used to simulate
492 atexit().  Each package's END block is called when the program or
493 thread ends (see L<perlmod> manpage for more details).  
494
495 For example, you can use this to make sure your filter program
496 managed to finish its output without filling up the disk:
497
498     END {
499         close(STDOUT) || die "stdout close failed: $!";
500     } 
501
502 The END block isn't called when untrapped signals kill the program,
503 though, so if you use END blocks you should also use
504
505         use sigtrap qw(die normal-signals);
506
507 Perl's exception-handling mechanism is its eval() operator.  You can
508 use eval() as setjmp and die() as longjmp.  For details of this, see
509 the section on signals, especially the time-out handler for a blocking
510 flock() in L<perlipc/"Signals"> or the section on ``Signals'' in
511 the Camel Book.
512
513 If exception handling is all you're interested in, try the
514 exceptions.pl library (part of the standard perl distribution).
515
516 If you want the atexit() syntax (and an rmexit() as well), try the
517 AtExit module available from CPAN.
518
519 =head2 Why doesn't my sockets program work under System V (Solaris)?  What does the error message "Protocol not supported" mean?
520
521 Some Sys-V based systems, notably Solaris 2.X, redefined some of the
522 standard socket constants.  Since these were constant across all
523 architectures, they were often hardwired into perl code.  The proper
524 way to deal with this is to "use Socket" to get the correct values.
525
526 Note that even though SunOS and Solaris are binary compatible, these
527 values are different.  Go figure.
528
529 =head2 How can I call my system's unique C functions from Perl?
530
531 In most cases, you write an external module to do it--see the answer
532 to "Where can I learn about linking C with Perl? [h2xs, xsubpp]".
533 However, if the function is a system call, and your system supports
534 syscall(), you can use the syscall function (documented in
535 L<perlfunc>).
536
537 Remember to check the modules that came with your distribution, and
538 CPAN as well--someone may already have written a module to do it.
539
540 =head2 Where do I get the include files to do ioctl() or syscall()?
541
542 Historically, these would be generated by the h2ph tool, part of the
543 standard perl distribution.  This program converts cpp(1) directives
544 in C header files to files containing subroutine definitions, like
545 &SYS_getitimer, which you can use as arguments to your functions.
546 It doesn't work perfectly, but it usually gets most of the job done.
547 Simple files like F<errno.h>, F<syscall.h>, and F<socket.h> were fine,
548 but the hard ones like F<ioctl.h> nearly always need to hand-edited.
549 Here's how to install the *.ph files:
550
551     1.  become super-user
552     2.  cd /usr/include
553     3.  h2ph *.h */*.h
554
555 If your system supports dynamic loading, for reasons of portability and
556 sanity you probably ought to use h2xs (also part of the standard perl
557 distribution).  This tool converts C header files to Perl extensions.
558 See L<perlxstut> for how to get started with h2xs.
559
560 If your system doesn't support dynamic loading, you still probably
561 ought to use h2xs.  See L<perlxstut> and L<ExtUtils::MakeMaker> for
562 more information (in brief, just use B<make perl> instead of a plain
563 B<make> to rebuild perl with a new static extension).
564
565 =head2 Why do setuid perl scripts complain about kernel problems?
566
567 Some operating systems have bugs in the kernel that make setuid
568 scripts inherently insecure.  Perl gives you a number of options
569 (described in L<perlsec>) to work around such systems.
570
571 =head2 How can I open a pipe both to and from a command?
572
573 The IPC::Open2 module (part of the standard perl distribution) is an
574 easy-to-use approach that internally uses pipe(), fork(), and exec() to do
575 the job.  Make sure you read the deadlock warnings in its documentation,
576 though (see L<IPC::Open2>).  See 
577 L<perlipc/"Bidirectional Communication with Another Process"> and 
578 L<perlipc/"Bidirectional Communication with Yourself">
579
580 You may also use the IPC::Open3 module (part of the standard perl
581 distribution), but be warned that it has a different order of
582 arguments from IPC::Open2 (see L<IPC::Open3>).
583
584 =head2 Why can't I get the output of a command with system()?
585
586 You're confusing the purpose of system() and backticks (``).  system()
587 runs a command and returns exit status information (as a 16 bit value:
588 the low 7 bits are the signal the process died from, if any, and
589 the high 8 bits are the actual exit value).  Backticks (``) run a
590 command and return what it sent to STDOUT.
591
592     $exit_status   = system("mail-users");
593     $output_string = `ls`;
594
595 =head2 How can I capture STDERR from an external command?
596
597 There are three basic ways of running external commands:
598
599     system $cmd;                # using system()
600     $output = `$cmd`;           # using backticks (``)
601     open (PIPE, "cmd |");       # using open()
602
603 With system(), both STDOUT and STDERR will go the same place as the
604 script's STDOUT and STDERR, unless the system() command redirects them.
605 Backticks and open() read B<only> the STDOUT of your command.
606
607 With any of these, you can change file descriptors before the call:
608
609     open(STDOUT, ">logfile");
610     system("ls");
611
612 or you can use Bourne shell file-descriptor redirection:
613
614     $output = `$cmd 2>some_file`;
615     open (PIPE, "cmd 2>some_file |");
616
617 You can also use file-descriptor redirection to make STDERR a
618 duplicate of STDOUT:
619
620     $output = `$cmd 2>&1`;
621     open (PIPE, "cmd 2>&1 |");
622
623 Note that you I<cannot> simply open STDERR to be a dup of STDOUT
624 in your Perl program and avoid calling the shell to do the redirection.
625 This doesn't work:
626
627     open(STDERR, ">&STDOUT");
628     $alloutput = `cmd args`;  # stderr still escapes
629
630 This fails because the open() makes STDERR go to where STDOUT was
631 going at the time of the open().  The backticks then make STDOUT go to
632 a string, but don't change STDERR (which still goes to the old
633 STDOUT).
634
635 Note that you I<must> use Bourne shell (sh(1)) redirection syntax in
636 backticks, not csh(1)!  Details on why Perl's system() and backtick
637 and pipe opens all use the Bourne shell are in the
638 F<versus/csh.whynot> article in the "Far More Than You Ever Wanted To
639 Know" collection in http://www.cpan.org/olddoc/FMTEYEWTK.tgz .  To
640 capture a command's STDERR and STDOUT together:
641
642     $output = `cmd 2>&1`;                       # either with backticks
643     $pid = open(PH, "cmd 2>&1 |");              # or with an open pipe
644     while (<PH>) { }                            #    plus a read
645
646 To capture a command's STDOUT but discard its STDERR:
647
648     $output = `cmd 2>/dev/null`;                # either with backticks
649     $pid = open(PH, "cmd 2>/dev/null |");       # or with an open pipe
650     while (<PH>) { }                            #    plus a read
651
652 To capture a command's STDERR but discard its STDOUT:
653
654     $output = `cmd 2>&1 1>/dev/null`;           # either with backticks
655     $pid = open(PH, "cmd 2>&1 1>/dev/null |");  # or with an open pipe
656     while (<PH>) { }                            #    plus a read
657
658 To exchange a command's STDOUT and STDERR in order to capture the STDERR
659 but leave its STDOUT to come out our old STDERR:
660
661     $output = `cmd 3>&1 1>&2 2>&3 3>&-`;        # either with backticks
662     $pid = open(PH, "cmd 3>&1 1>&2 2>&3 3>&-|");# or with an open pipe
663     while (<PH>) { }                            #    plus a read
664
665 To read both a command's STDOUT and its STDERR separately, it's easiest
666 and safest to redirect them separately to files, and then read from those
667 files when the program is done:
668
669     system("program args 1>/tmp/program.stdout 2>/tmp/program.stderr");
670
671 Ordering is important in all these examples.  That's because the shell
672 processes file descriptor redirections in strictly left to right order.
673
674     system("prog args 1>tmpfile 2>&1");
675     system("prog args 2>&1 1>tmpfile");
676
677 The first command sends both standard out and standard error to the
678 temporary file.  The second command sends only the old standard output
679 there, and the old standard error shows up on the old standard out.
680
681 =head2 Why doesn't open() return an error when a pipe open fails?
682
683 Because the pipe open takes place in two steps: first Perl calls
684 fork() to start a new process, then this new process calls exec() to
685 run the program you really wanted to open.  The first step reports
686 success or failure to your process, so open() can only tell you
687 whether the fork() succeeded or not.
688
689 To find out if the exec() step succeeded, you have to catch SIGCHLD
690 and wait() to get the exit status.  You should also catch SIGPIPE if
691 you're writing to the child--you may not have found out the exec()
692 failed by the time you write.  This is documented in L<perlipc>.
693
694 In some cases, even this won't work.  If the second argument to a
695 piped open() contains shell metacharacters, perl fork()s, then exec()s
696 a shell to decode the metacharacters and eventually run the desired
697 program.  Now when you call wait(), you only learn whether or not the
698 I<shell> could be successfully started...it's best to avoid shell
699 metacharacters.
700
701 On systems that follow the spawn() paradigm, open() I<might> do what
702 you expect--unless perl uses a shell to start your command. In this
703 case the fork()/exec() description still applies.
704
705 =head2 What's wrong with using backticks in a void context?
706
707 Strictly speaking, nothing.  Stylistically speaking, it's not a good
708 way to write maintainable code because backticks have a (potentially
709 humongous) return value, and you're ignoring it.  It's may also not be very
710 efficient, because you have to read in all the lines of output, allocate
711 memory for them, and then throw it away.  Too often people are lulled
712 to writing:
713
714     `cp file file.bak`;
715
716 And now they think "Hey, I'll just always use backticks to run programs."
717 Bad idea: backticks are for capturing a program's output; the system()
718 function is for running programs.
719
720 Consider this line:
721
722     `cat /etc/termcap`;
723
724 You haven't assigned the output anywhere, so it just wastes memory
725 (for a little while).  You forgot to check C<$?> to see whether
726 the program even ran correctly, too.  Even if you wrote
727
728     print `cat /etc/termcap`;
729
730 this code could and probably should be written as
731
732     system("cat /etc/termcap") == 0
733         or die "cat program failed!";
734
735 which will get the output quickly (as it is generated, instead of only
736 at the end) and also check the return value.
737
738 system() also provides direct control over whether shell wildcard
739 processing may take place, whereas backticks do not.
740
741 =head2 How can I call backticks without shell processing?
742
743 This is a bit tricky.  Instead of writing
744
745     @ok = `grep @opts '$search_string' @filenames`;
746
747 You have to do this:
748
749     my @ok = ();
750     if (open(GREP, "-|")) {
751         while (<GREP>) {
752             chomp;
753             push(@ok, $_);
754         }
755         close GREP;
756     } else {
757         exec 'grep', @opts, $search_string, @filenames;
758     }
759
760 Just as with system(), no shell escapes happen when you exec() a list.
761 Further examples of this can be found in L<perlipc/"Safe Pipe Opens">.
762
763 Note that if you're stuck on Microsoft, no solution to this vexing issue
764 is even possible.  Even if Perl were to emulate fork(), you'd still
765 be hosed, because Microsoft gives no argc/argv-style API.  Their API
766 always reparses from a single string, which is fundamentally wrong,
767 but you're not likely to get the Gods of Redmond to acknowledge this
768 and fix it for you.
769
770 =head2 Why can't my script read from STDIN after I gave it EOF (^D on Unix, ^Z on MS-DOS)?
771
772 Some stdio's set error and eof flags that need clearing.  The
773 POSIX module defines clearerr() that you can use.  That is the
774 technically correct way to do it.  Here are some less reliable
775 workarounds:
776
777 =over 4
778
779 =item 1
780
781 Try keeping around the seekpointer and go there, like this:
782
783     $where = tell(LOG);
784     seek(LOG, $where, 0);
785
786 =item 2
787
788 If that doesn't work, try seeking to a different part of the file and
789 then back.
790
791 =item 3
792
793 If that doesn't work, try seeking to a different part of
794 the file, reading something, and then seeking back.
795
796 =item 4
797
798 If that doesn't work, give up on your stdio package and use sysread.
799
800 =back
801
802 =head2 How can I convert my shell script to perl?
803
804 Learn Perl and rewrite it.  Seriously, there's no simple converter.
805 Things that are awkward to do in the shell are easy to do in Perl, and
806 this very awkwardness is what would make a shell->perl converter
807 nigh-on impossible to write.  By rewriting it, you'll think about what
808 you're really trying to do, and hopefully will escape the shell's
809 pipeline datastream paradigm, which while convenient for some matters,
810 causes many inefficiencies.
811
812 =head2 Can I use perl to run a telnet or ftp session?
813
814 Try the Net::FTP, TCP::Client, and Net::Telnet modules (available from
815 CPAN).  http://www.cpan.org/scripts/netstuff/telnet.emul.shar
816 will also help for emulating the telnet protocol, but Net::Telnet is
817 quite probably easier to use..
818
819 If all you want to do is pretend to be telnet but don't need
820 the initial telnet handshaking, then the standard dual-process
821 approach will suffice:
822
823     use IO::Socket;             # new in 5.004
824     $handle = IO::Socket::INET->new('www.perl.com:80')
825             || die "can't connect to port 80 on www.perl.com: $!";
826     $handle->autoflush(1);
827     if (fork()) {               # XXX: undef means failure
828         select($handle);
829         print while <STDIN>;    # everything from stdin to socket
830     } else {
831         print while <$handle>;  # everything from socket to stdout
832     }
833     close $handle;
834     exit;
835
836 =head2 How can I write expect in Perl?
837
838 Once upon a time, there was a library called chat2.pl (part of the
839 standard perl distribution), which never really got finished.  If you
840 find it somewhere, I<don't use it>.  These days, your best bet is to
841 look at the Expect module available from CPAN, which also requires two
842 other modules from CPAN, IO::Pty and IO::Stty.
843
844 =head2 Is there a way to hide perl's command line from programs such as "ps"?
845
846 First of all note that if you're doing this for security reasons (to
847 avoid people seeing passwords, for example) then you should rewrite
848 your program so that critical information is never given as an
849 argument.  Hiding the arguments won't make your program completely
850 secure.
851
852 To actually alter the visible command line, you can assign to the
853 variable $0 as documented in L<perlvar>.  This won't work on all
854 operating systems, though.  Daemon programs like sendmail place their
855 state there, as in:
856
857     $0 = "orcus [accepting connections]";
858
859 =head2 I {changed directory, modified my environment} in a perl script.  How come the change disappeared when I exited the script?  How do I get my changes to be visible?
860
861 =over 4
862
863 =item Unix
864
865 In the strictest sense, it can't be done--the script executes as a
866 different process from the shell it was started from.  Changes to a
867 process are not reflected in its parent--only in any children
868 created after the change.  There is shell magic that may allow you to
869 fake it by eval()ing the script's output in your shell; check out the
870 comp.unix.questions FAQ for details.  
871
872 =back
873
874 =head2 How do I close a process's filehandle without waiting for it to complete?
875
876 Assuming your system supports such things, just send an appropriate signal
877 to the process (see L<perlfunc/"kill">).  It's common to first send a TERM
878 signal, wait a little bit, and then send a KILL signal to finish it off.
879
880 =head2 How do I fork a daemon process?
881
882 If by daemon process you mean one that's detached (disassociated from
883 its tty), then the following process is reported to work on most
884 Unixish systems.  Non-Unix users should check their Your_OS::Process
885 module for other solutions.
886
887 =over 4
888
889 =item *
890
891 Open /dev/tty and use the TIOCNOTTY ioctl on it.  See L<tty(4)>
892 for details.  Or better yet, you can just use the POSIX::setsid()
893 function, so you don't have to worry about process groups.
894
895 =item *
896
897 Change directory to /
898
899 =item *
900
901 Reopen STDIN, STDOUT, and STDERR so they're not connected to the old
902 tty.
903
904 =item *
905
906 Background yourself like this:
907
908     fork && exit;
909
910 =back
911
912 The Proc::Daemon module, available from CPAN, provides a function to
913 perform these actions for you.
914
915 =head2 How do I find out if I'm running interactively or not?
916
917 Good question.  Sometimes C<-t STDIN> and C<-t STDOUT> can give clues,
918 sometimes not.
919
920     if (-t STDIN && -t STDOUT) {
921         print "Now what? ";
922     }
923
924 On POSIX systems, you can test whether your own process group matches
925 the current process group of your controlling terminal as follows:
926
927     use POSIX qw/getpgrp tcgetpgrp/;
928     open(TTY, "/dev/tty") or die $!;
929     $tpgrp = tcgetpgrp(fileno(*TTY));
930     $pgrp = getpgrp();
931     if ($tpgrp == $pgrp) {
932         print "foreground\n";
933     } else {
934         print "background\n";
935     }
936
937 =head2 How do I timeout a slow event?
938
939 Use the alarm() function, probably in conjunction with a signal
940 handler, as documented in L<perlipc/"Signals"> and the section on
941 ``Signals'' in the Camel.  You may instead use the more flexible
942 Sys::AlarmCall module available from CPAN.
943
944 =head2 How do I set CPU limits?
945
946 Use the BSD::Resource module from CPAN.
947
948 =head2 How do I avoid zombies on a Unix system?
949
950 Use the reaper code from L<perlipc/"Signals"> to call wait() when a
951 SIGCHLD is received, or else use the double-fork technique described
952 in L<perlfunc/fork>.
953
954 =head2 How do I use an SQL database?
955
956 There are a number of excellent interfaces to SQL databases.  See the
957 DBD::* modules available from http://www.cpan.org/modules/DBD .
958 A lot of information on this can be found at http://dbi.perl.org/
959
960 =head2 How do I make a system() exit on control-C?
961
962 You can't.  You need to imitate the system() call (see L<perlipc> for
963 sample code) and then have a signal handler for the INT signal that
964 passes the signal on to the subprocess.  Or you can check for it:
965
966     $rc = system($cmd);
967     if ($rc & 127) { die "signal death" } 
968
969 =head2 How do I open a file without blocking?
970
971 If you're lucky enough to be using a system that supports
972 non-blocking reads (most Unixish systems do), you need only to use the
973 O_NDELAY or O_NONBLOCK flag from the Fcntl module in conjunction with
974 sysopen():
975
976     use Fcntl;
977     sysopen(FH, "/tmp/somefile", O_WRONLY|O_NDELAY|O_CREAT, 0644)
978         or die "can't open /tmp/somefile: $!":
979
980 =head2 How do I install a module from CPAN?
981
982 The easiest way is to have a module also named CPAN do it for you.
983 This module comes with perl version 5.004 and later.  To manually install
984 the CPAN module, or any well-behaved CPAN module for that matter, follow
985 these steps:
986
987 =over 4
988
989 =item 1
990
991 Unpack the source into a temporary area.
992
993 =item 2
994
995     perl Makefile.PL
996
997 =item 3
998
999     make
1000
1001 =item 4
1002
1003     make test
1004
1005 =item 5
1006
1007     make install
1008
1009 =back
1010
1011 If your version of perl is compiled without dynamic loading, then you
1012 just need to replace step 3 (B<make>) with B<make perl> and you will
1013 get a new F<perl> binary with your extension linked in.
1014
1015 See L<ExtUtils::MakeMaker> for more details on building extensions.
1016 See also the next question, ``What's the difference between require
1017 and use?''.
1018
1019 =head2 What's the difference between require and use?
1020
1021 Perl offers several different ways to include code from one file into
1022 another.  Here are the deltas between the various inclusion constructs:
1023
1024     1)  do $file is like eval `cat $file`, except the former
1025         1.1: searches @INC and updates %INC.
1026         1.2: bequeaths an *unrelated* lexical scope on the eval'ed code.
1027
1028     2)  require $file is like do $file, except the former
1029         2.1: checks for redundant loading, skipping already loaded files.
1030         2.2: raises an exception on failure to find, compile, or execute $file.
1031
1032     3)  require Module is like require "Module.pm", except the former
1033         3.1: translates each "::" into your system's directory separator.
1034         3.2: primes the parser to disambiguate class Module as an indirect object.
1035
1036     4)  use Module is like require Module, except the former
1037         4.1: loads the module at compile time, not run-time.
1038         4.2: imports symbols and semantics from that package to the current one.
1039
1040 In general, you usually want C<use> and a proper Perl module.
1041
1042 =head2 How do I keep my own module/library directory?
1043
1044 When you build modules, use the PREFIX option when generating
1045 Makefiles:
1046
1047     perl Makefile.PL PREFIX=/u/mydir/perl
1048
1049 then either set the PERL5LIB environment variable before you run
1050 scripts that use the modules/libraries (see L<perlrun>) or say
1051
1052     use lib '/u/mydir/perl';
1053
1054 This is almost the same as
1055
1056     BEGIN {
1057         unshift(@INC, '/u/mydir/perl');
1058     }
1059
1060 except that the lib module checks for machine-dependent subdirectories.
1061 See Perl's L<lib> for more information.
1062
1063 =head2 How do I add the directory my program lives in to the module/library search path?
1064
1065     use FindBin;
1066     use lib "$FindBin::Bin";
1067     use your_own_modules;
1068
1069 =head2 How do I add a directory to my include path at runtime?
1070
1071 Here are the suggested ways of modifying your include path:
1072
1073     the PERLLIB environment variable
1074     the PERL5LIB environment variable
1075     the perl -Idir command line flag
1076     the use lib pragma, as in
1077         use lib "$ENV{HOME}/myown_perllib";
1078
1079 The latter is particularly useful because it knows about machine
1080 dependent architectures.  The lib.pm pragmatic module was first
1081 included with the 5.002 release of Perl.
1082
1083 =head2 What is socket.ph and where do I get it?
1084
1085 It's a perl4-style file defining values for system networking
1086 constants.  Sometimes it is built using h2ph when Perl is installed,
1087 but other times it is not.  Modern programs C<use Socket;> instead.
1088
1089 =head1 AUTHOR AND COPYRIGHT
1090
1091 Copyright (c) 1997-2002 Tom Christiansen and Nathan Torkington.
1092 All rights reserved.
1093
1094 This documentation is free; you can redistribute it and/or modify it
1095 under the same terms as Perl itself.
1096
1097 Irrespective of its distribution, all code examples in this file
1098 are hereby placed into the public domain.  You are permitted and
1099 encouraged to use this code in your own programs for fun
1100 or for profit as you see fit.  A simple comment in the code giving
1101 credit would be courteous but is not required.