Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CPAN::HandleConfig(3)
internal configuration handling for CPAN.pm n .SS """CLASS->safe_quote ITEM""" .SS "CLASS->safe_quote ITEM" Subsection "CLASS->safe_quote ITEM" Quotes an item to become safe against spaces in shell interpolation. An item is enclosed in double quotes if: - the item contains spaces in the middle - the item does not start with a quote This happens to avoid shell interpolation problems when whitespace is present in directory names. This method uses commands_quote to determine the correct quote. If commands_quote is a space, no quoting will take place. if it starts and ends with the same quote character: leave it as it is if it contains no whitespace: leave it as it is if it contains whitespace, then if it contains quotes: better leave it as it is else: quote it with the correct quote type for the box we're on
CPANPLUS::Internals::Source::Memory(3)
In memory implementation n .SS "$cb->_|_memory_retrieve_source(name => $name, [path => $path, uptodate => BOOL, verbose => BOOL])" .SS "$cb->_|_memory_retrieve_source(name => $name, [path => $path, uptodate => BOOL, verbose => BOOL])" Subsection "$cb->__memory_retrieve_source(name => $name, [path => $path, uptodate => BOOL, verbose => BOOL])" This method retrieves a storabled tree identified by $name. It takes the following arguments: "name" 4 Item "name" The internal name for the source file to retrieve. "uptodate" 4 Item "uptodate" A flag indicating whether the file-cache is up-to-date or not. "path" 4 Item "path" The absolute path to the directory holding the source files. "verbose" 4 Item "verbose" A boolean flag indicating whether or not to be verbose. Will get information from the config file by default. Returns a tree on success, false on failure. n .SS "$cb->_|_memory_save_source([verbose => BOOL, path => $path])" .SS "$cb->_|_memory_save_source([verbose => BOOL, path => $path])" Subsection "$cb->__memory_save_source([verbose => BOOL, path => $path])" This method saves all the parsed trees in storabled format if Storable is available. It takes the following arguments: "path" 4 Item "path" The absolute path to the directory holding the source files. "verbose" 4 Item "verbose" A boolean flag indicating whether or not to be verbose. Will get information from the config file by default. Returns true on success, false on failure
DBIx::Class::Helper::ResultSet::Shortcut::Search::Like(3)
n .SS "like($column || e@columns, $cond)" .SS "like($column || e@columns, $cond)" Subsection "like($column || @columns, $cond)" $rs->like(lyrics, %zebra%); $rs->like([lyrics, title], %zebra%);
DBIx::Class::Helper::ResultSet::Shortcut::Search::NotLike(3)
n .SS "not_like($column || e@columns, $cond)" .SS "not_like($column || e@columns, $cond)" Subsection "not_like($column || @columns, $cond)" $rs->not_like(lyrics, %zebra%); $rs->not_like([lyrics, title], %zebra%);
DBIx::Class::Manual::Troubleshooting(3)
Got a problem? Shoot it. n .SS """Can't locate storage blabla""" .SS "``Can't locate storage blabla''" Subsection "Can't locate storage blabla" You're trying to make a query on a non-connected schema. Make sure you got the current resultset from $schema->resultset('Artist') on a schema object you got back from connect()
Font::TTF::AATutils(3)
Utility functions for AAT tables n .SS "($classes, $states) = AAT_read_subtable($fh, $baseOffset, $subtableStart, $limits)" .SS "($classes, $states) = AAT_read_subtable($fh, $baseOffset, $subtableStart, $limits)" Subsection "($classes, $states) = AAT_read_subtable($fh, $baseOffset, $subtableStart, $limits)" n .SS "$length = AAT_write_state_table($fh, $classes, $states, $numExtraTables, $packEntry)" .SS "$length = AAT_write_state_table($fh, $classes, $states, $numExtraTables, $packEntry)" Subsection "$length = AAT_write_state_table($fh, $classes, $states, $numExtraTables, $packEntry)" $packEntry is a subroutine for packing an entry into binary form, called as $dat = $packEntry($entry, $entryTable, $numEntries) where the entry is a comma-separated list of nextStateOffset, flags, actions n .SS "($classes, $states, $entries) = AAT_read_state_table($fh, $numActionWords)" .SS "($classes, $states, $entries) = AAT_read_state_table($fh, $numActionWords)" Subsection "($classes, $states, $entries) = AAT_read_state_table($fh, $numActionWords)" n .SS "($format, $lookup) = AAT_read_lookup($fh, $valueSize, $length, $default)" .SS "($format, $lookup) = AAT_read_lookup($fh, $valueSize, $length, $default)" Subsection "($format, $lookup) = AAT_read_lookup($fh, $valueSize, $length, $default)" n .SS "AAT_write_lookup($fh, $format, $lookup, $valueSize, $default)" .SS "AAT_write_lookup($fh, $format, $lookup, $valueSize, $default)" Subsection "AAT_write_lookup($fh, $format, $lookup, $valueSize, $default)"
Font::TTF::Mort::Chain(3)
Chain Mort subtable for AAT n .SS "$t->new" .SS "$t->new" Subsection "$t->new" n .SS "$t->read($fh)" .SS "$t->read($fh)" Subsection "$t->read($fh)" Reads the chain into memory n .SS "$t->out($fh)" .SS "$t->out($fh)" Subsection "$t->out($fh)" Writes the table to a file either from memory or by copying n .SS "$t->print($fh)" .SS "$t->print($fh)" Subsection "$t->print($fh)" Prints a human-readable representation of the chain
HTML::Display::Common(3)
routines common to all HTML::Display subclasses n .SS "_|_PACKAGE_|_->new %ARGS" .SS "_|_PACKAGE_|_->new %ARGS" Subsection "__PACKAGE__->new %ARGS" Creates a new object as a blessed hash. The passed arguments are stored within the hash. If you need to do other things in your constructor, remember to call this constructor as well : package HTML::Display::WhizBang; use parent HTML::Display::Common; sub new { my ($class) = shift; my %args = @_; my $self = $class->SUPER::new(%args); # do stuff $self; }; n .SS "$display->display %ARGS" .SS "$display->display %ARGS" Subsection "$display->display %ARGS" This is the routine used to display the HTML to the user. It takes the following parameters : html => SCALAR containing the HTML file => SCALAR containing the filename of the file to be displayed base => optional base url for the HTML, so that relative links still work location (synonymous to base) Basic usage : Subsection "Basic usage :" my $html = "<html><body><h1>Hello world!</h1></body></html>"; my $browser = HTML::Display->new(); $browser->display( html => $html ); Location parameter : Subsection "Location parameter :" If you fetch a page from a remote site but still want to display it to the user, the location parameter comes in very handy : my $html = <html><body><img src="/images/hp0.gif"></body></html>; my $browser = HTML::Display->new(); # This will display part of the Google logo $browser->display( html => $html, base => http://www.google.com );
Jifty::Manual::Style(3)
Jifty coding style guide Default style Subsection "Default style" When in doubt, default to whatever Damian Conway's Perl Best Practices says. Private documentation Subsection "Private documentation" When documenting a private method, or providing documentation which is not useful to the user of the module (and is presumably useful to the developer), wrap it in =begin/end private. This way it does not show up in perldoc where a user would see it and yet is still available and well formatted (that is, not just a lump comment) when looking at the code. =begin private =head2 import_extra Called by L<Test::More>s C<import> code when L<Jifty::Test> is first C<use>d, it calls L</setup>, and asks Test::More to export its symbols to the namespace that C<use>d this one. =end private sub import_extra { ... } Test temp files Subsection "Test temp files" Files created by tests should be declared as such using Jifty::Test->test_file() so they are cleaned up on a successful test run. Use Shell::Command Subsection "Use Shell::Command" Shell::Command has a number of functions which work like common shell file commands such as touch, cp and mv. They are battle tested and cross-platform. Use them instead of coding your own. For example, instead of this: open my $file, ">foo"; close $file; Do this: use Shell::Command; touch $file; Case insensitive matching Subsection "Case insensitive matching" To check if a string equals another string case insensitively, do this lc $foo eq lc $bar; lc $foo eq bar; not this: $foo =~ /^eQ$bareE/i; $foo =~ /^bar$/i;
PDF::API3::Compat::API2::Basic::TTF::Mort::Chain(3)
n .SS "$t->new" .SS "$t->new" Subsection "$t->new" n .SS "$t->read($fh)" .SS "$t->read($fh)" Subsection "$t->read($fh)" Reads the chain into memory n .SS "$t->out($fh)" .SS "$t->out($fh)" Subsection "$t->out($fh)" Writes the table to a file either from memory or by copying n .SS "$t->print($fh)" .SS "$t->print($fh)" Subsection "$t->print($fh)" Prints a human-readable representation of the chain
Perl::Metrics::Lite::FileFinder(3)
find perl files in paths n .SS "find_files( @directories_and_files )" .SS "find_files( @directories_and_files )" Subsection "find_files( @directories_and_files )" Uses list_perl_files to find all the readable Perl files and returns a reference to a (possibly empty) list of paths
Spreadsheet::ParseODS::Workbook(3)
a workbook n .SS """->filename""" .SS "->filename" Subsection "->filename" print $workbook->filename; The name of the file if applicable. n .SS """->table_styles""" .SS "->table_styles" Subsection "->table_styles" The styles that identify whether a table is hidden, and other styles n .SS """->get_print_areas()""" .SS "->get_print_areas()" Subsection "->get_print_areas()" my $print_areas = $workbook->get_print_areas(); # [[ [$start_row, $start_col, $end_row, $end_col], ... ]] The ->get_print_areas() method returns the print areas of each sheet as an arrayref of arrayrefs. If a sheet has no print area, undef is returned for its print area. n .SS """->get_active_sheet()""" .SS "->get_active_sheet()" Subsection "->get_active_sheet()" my $sheet = $workbook->get_active_sheet(); if( !$sheet ) { # If there is no defined active worksheet, take the first: ($sheet) = $workbook->worksheets(); }; Returns the active worksheet, or if there is no such sheet, returns undef. n .SS """->worksheets()""" .SS "->worksheets()" Subsection "->worksheets()" my @sheets = $workbook->worksheets; Returns the list of worksheets as Spreadsheet::ParseODS::Worksheet objects. n .SS """->worksheet($name)""" .SS "->worksheet($name)" Subsection "->worksheet($name)" my $sheet1 = $workbook->worksheet(Sheet 1); Returns the worksheet with the given name, or if no such worksheet exists, returns undef
Spreadsheet::ParseODS::Worksheet(3)
a sheet in a workbook n .SS """get_print_areas()""" .SS "get_print_areas()" Subsection "get_print_areas()" my $print_areas = $worksheet->get_print_areas(); # [ [$start_row, $start_col, $end_row, $end_col], ... ] The ->get_print_areas() method returns the print areas of the sheet as an arrayref. Returns undef if there are no print areas
home | help