Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

file::inplace(3) [centos man page]

File::Inplace(3)					User Contributed Perl Documentation					  File::Inplace(3)

File::Inplace - Perl module for in-place editing of files SYNOPSIS
use File::Inplace; my $editor = new File::Inplace(file => "file.txt"); while (my ($line) = $editor->next_line) { $editor->replace_line(reverse $line); } $editor->commit; DESCRIPTION
File::Inplace is a perl module intended to ease the common task of editing a file in-place. Inspired by variations of perl's -i option, this module is intended for somewhat more structured and reusable editing than command line perl typically allows. File::Inplace endeavors to guarantee file integrity; that is, either all of the changes made will be saved to the file, or none will. It also offers functionality such as backup creation, automatic field splitting per-line, automatic chomping/unchomping, and aborting edits partially through without affecting the original file. CONSTRUCTOR
File::Inplace offers one constructor that accepts a number of parameters, one of which is required. File::Inplace->new(file => "filename", ...) file The one required parameter. This is the name of the file to edit. suffix The suffix for backup files. If not specified, no backups are made. chomp If set to zero, then automatic chomping will not be performed. Newlines (actually, the contents of $/) will remain in strings returned from "next_line". Additionally, the contents of $/ will not be appended when replacing lines. regex If specified, then each line will be split by this parameter when using "next_line_split" method. If unspecified, then this defaults to s+. separator The default character used to join each line when replace_line is invoked with a list instead of a single value. Defaults to a single space. INSTANCE METHODS
$editor->next_line () In scalar context, it returns the next line of the input file, or undef if there is no line. In an array context, it returns a single value of the line, or an empty list if there is no line. $editor->replace_line (value) Replaces the current line in the output file with the specified value. If passed a list, then each valie is joined by the "separator" specified at construction time. $editor->next_line_split () Line "next_line", except splits based on the "regex" specified in the constructor. $editor->has_lines () Returns true if the file contains any further lines. $editor->all_lines () Returns an array of all lines in the file being edited. $editor->replace_all_lines (@lines) Replaces all remaining lines in the file with the specified @lines. $editor->commit () Completes the edit operation and saves the changes to the edited file. $editor->rollback () Aborts the edit process. $editor->commit_to_backup () Saves edits to the backup file instead of the original file. AUTHOR
Copyright (C) 2005 by Chip Turner This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.6.0 or, at your option, any later version of Perl 5 you may have available. POD ERRORS
Hey! The above document had some coding errors, which are explained below: Around line 283: You forgot a '=back' before '=head1' Around line 285: '=item' outside of any '=over' perl v5.16.3 2005-01-29 File::Inplace(3)

Check Out this Related Man Page

Vend::Table::Editor(3pm)				User Contributed Perl Documentation				  Vend::Table::Editor(3pm)

Vend::Table::Editor -- Interchange do-all HTML table editor SYNOPSIS
[table-editor OPTIONS] [table-editor OPTIONS] TEMPLATE [/table-editor] DESCRIPTION
The [table-editor] tag produces an HTML form that edits a database table or collects values for a "wizard". It is extremely configurable as to display and characteristics of the widgets used to collect the input. The widget types are based on the Interchange "[display ...]" UserTag, which in turn is heavily based on the ITL core "[accessories ...]" tag. The "simplest" form of "[table-editor]" is: [table-editor table=foo] A page which contains only that tag will edit the table "foo", where "foo" is the name of an Interchange table to edit. If no "foo" table is "defined", then nothing will be displayed. If the "mv_metadata" entry "foo" is present, it is used as the definition for table display, including the fields to edit and labels for sections of the form. If "ui_data_fields" is defined, this cancels fetch of the view and any breaks and labels must be defined with "ui_break_before" and "ui_break_before_label". More on the view concept later. A simple "wizard" can be made with: [table-editor wizard=1 ui_wizard_fields="foo bar" mv_nextpage=wizard2 mv_prevpage=wizard_intro ] The purpose of a "wizard" is to collect values from the user and place them in the $Values array. A next page value (option mv_nextpage) must be defined to give a destination; if mv_prevpage is defined then a "Back" button is presented to allow paging backward in the wizard. perl v5.14.2 2011-03-09 Vend::Table::Editor(3pm)
Man Page

Featured Tech Videos