#! @PERL@ #-*- mode: perl; perl-indent-level: 4; cperl-indent-level: 4 -*- # # ${R_HOME}/bin/build-help # Usage: build-help [options] [pkg] [lib] # Install all help files for package pkg to library lib # (defaults are `${R_HOME}/src/library/base' and the default library, # `${R_HOME}/library', respectively). use File::Basename; use Cwd; use Getopt::Long; @knownoptions = ("rhome:s", "html", "nroff", "latex", "example", "debug", "dosnames", "htmllists"); GetOptions (@knownoptions) || usage(); $cwd=getcwd(); if($opt_rhome){ $R_HOME=$opt_rhome; print STDERR "R_HOME from --rhome: `$R_HOME'\n" if $opt_debug; } elsif($ENV{"R_HOME"}){ $R_HOME=$ENV{"R_HOME"}; print STDERR "R_HOME from ENV: `$R_HOME'\n" if $opt_debug; } else{ chdir(dirname($0) . "/.."); $R_HOME=getcwd(); } chdir($cwd); print STDERR "Current directory (cwd): `$cwd'\n" if $opt_debug; require "$R_HOME/etc/Rdconvlib.pl"; require "$R_HOME/etc/buildlib.pl"; $NROFF="@NROFF@" unless $NROFF=$ENV{"NROFF"}; $TBL="@TBL@" unless $TBL=$ENV{"TBL"}; # if option --htmllists is set we only rebuild some list files and # exit if($opt_htmllists){ build_htmlpkglist("$R_HOME/library"); %anindex = read_anindex("$R_HOME/library"); %htmlindex = read_htmlindex("$R_HOME/library"); build_htmlfctlist("$R_HOME/library"); exit 0; } # default is to build all documentation formats if(!$opt_html && !$opt_nroff && !$opt_latex && !$opt_example){ $opt_html = 1; $opt_nroff = 1; $opt_latex = 1; $opt_example = 1; } ($pkg, $lib, @mandir) = buildinit(); $dest = "$lib/$pkg"; print STDERR "Destination `dest'= `$dest'\n" if $opt_debug; build_index(); if ($opt_latex) { $latex_d="$dest/latex"; mkdir "$latex_d", $dir_mod || die "Could not create $latex_d: $!\n"; } if ($opt_example) { $Rex_d="$dest/R-ex"; mkdir "$Rex_d", $dir_mod || die "Could not create $Rex_d: $!\n"; } print " >>> Building/Updating help pages for package `$pkg'\n"; print " Formats: "; print "text " if $opt_nroff; print "html " if $opt_html; print "latex " if $opt_latex; print "example " if $opt_example; print "\n"; # get %htmlindex and %anindex %anindex = read_anindex($lib); if($opt_html){ %htmlindex = read_htmlindex($lib); if ($lib ne "$R_HOME/library") { %basehtmlindex = read_htmlindex("$R_HOME/library"); foreach $topic (keys %htmlindex) { $basehtmlindex{$topic} = $htmlindex{$topic}; } %htmlindex = %basehtmlindex; } # build_htmlfctlist($lib); } format STDOUT = @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< @<<<<<< @<<<<<< @<<<<<< @<<<<<< $manfilebase, $textflag, $htmlflag, $latexflag, $exampleflag . foreach $manfile (@mandir) { if($manfile =~ /\.[Rr]d$/) { $manfilebase = basename($manfile, (".Rd", ".rd")); $manage = (-M $manfile); $textflag = $htmlflag = $latexflag = $exampleflag = ""; if($opt_nroff){ my $targetfile = $filenm{$manfilebase}; $destfile = "$dest/help/$targetfile"; if(fileolder($destfile, $manage)) { $textflag = "text"; open(nroffout, "| $TBL | $NROFF -ms 2> /dev/null | " . " ${R_HOME}/bin/help.pretty > '$destfile'"); Rdconv($manfile, "nroff", "", -1); } } if($opt_html){ my $targetfile = $filenm{$manfilebase}; $misslink = ""; $destfile = "$dest/html/$targetfile.$HTML"; if(fileolder($destfile,$manage)) { $htmlflag = "html"; print "\t$destfile" if $opt_debug; Rdconv($manfile, "html", "", "$destfile"); } } if($opt_latex){ my $targetfile = $filenm{$manfilebase}; $destfile = "$dest/latex/$targetfile.tex"; if(fileolder($destfile,$manage)) { $latexflag = "latex"; Rdconv($manfile, "latex", "", "$destfile"); } } if($opt_example){ my $targetfile = $filenm{$manfilebase}; $destfile = "$dest/R-ex/$targetfile.R"; if(fileolder($destfile,$manage)) { Rdconv($manfile, "example", "", "$destfile"); if(-f$destfile) {$exampleflag = "example";} } } write if ($textflag || $htmlflag || $latexflag || $exampleflag); print " missing link(s): $misslink\n" if $htmlflag && length($misslink); } } sub usage { print "Usage: build-help [--rhome dir] [--html] [--nroff] [--latex]\n" . " [--example] [--dosnames] [--htmllists] [--debug]\n" . " [pkg] [lib]\n"; exit 0; }