https://github.com/songmu/p5-script-ichigeki

ichigeki hissatsu!
https://github.com/songmu/p5-script-ichigeki

Last synced: 2 days ago
JSON representation

ichigeki hissatsu!

• Host: GitHub
• URL: https://github.com/songmu/p5-script-ichigeki
• Owner: Songmu
• License: other
• Created: 2012-12-02T12:55:30.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2014-06-07T07:51:32.000Z (over 10 years ago)
• Last Synced: 2024-10-11T21:09:34.475Z (27 days ago)
• Language: Perl
• Size: 168 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

        
# NAME

Script::Ichigeki - Perl extension for one time script.

# VERSION

This document describes Script::Ichigeki version 0.04.

# SYNOPSIS

    use Script::Ichigeki;

It is same as

    use Script::Ichigeki (

        exec_date       => 'XXXX-XX-XX', # today

        confirm_dialog  => 1,

        dialog_message  => 'Do you really execute `%s` ?',

    );

or

    use Script::Ichigeki ();

    Script::Ichigeki->hissatsu(

        exec_date       => 'XXXX-XX-XX', # today

        confirm_dialog  => 1,

        dialog_message  => 'Do you really execute `%s` ?',

    );

# DESCRIPTION

Script::Ichigeki is the module for one time script for mission critical

(especially for preventing rerunning it).

Only describing \`use Script::Ichigeki\`, confirm dialog is displayed and execution result

is saved in log file automatically. This log file double with lock file for mutual exclusion

and preventing rerunning.

# CAUTION

THE SOFTWARE IS IT'S IN ALPHA QUALITY. IT MAY CHANGE THE API WITHOUT NOTICE.

If forking in your script, the software may not be properly handling it.

# INTERFACE

## Functions

### `hissatsu(%options)`

Automatically called in use phase.

Available options are:

#### `exec_date => 'Str|Time::Piece'`

Date for execution date. Format is '%Y-%m-%d'.

#### `confirm_dialog => 'Bool'`

Confirm dialog is to be displayed or not.

default: 1

#### `dialog_message => 'Str'`

Message of confirm dialog.

Script name is expanded to '%s'.

If using multibyte strings, you should `$ use utf8;` before `$ use Script::Ichigeki`.

default: 'Do you really execute \`%s\` ?',

# DEPENDENCIES

Perl 5.8.1 or later.

# BUGS

All complex software has bugs lurking in it, and this module is no

exception. If you find a bug please either email me, or add the bug

to cpan-RT.

# SEE ALSO

[perl](http://search.cpan.org/perldoc?perl)

# AUTHOR

Masayuki Matsuki 

# LICENSE AND COPYRIGHT

Copyright (c) 2012, Masayuki Matsuki. All rights reserved.

This library is free software; you can redistribute it and/or modify

it under the same terms as Perl itself.