Sys::VirtV2V::UserMessage.3pm

Langue: en

Version: 2010-07-01 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Sys::VirtV2V::UserMessage - Create consistent user messages

SYNOPSIS

  use Sys::VirtV2V::UserMessage qw(user_message);
 
  Sys::VirtV2V::UserMessage->set_identifier(__'virt-v2v');
 
  print STDERR user_message(__x("Couldn't open {file}: {error}",
                                file => $file, error => $error));

DESCRIPTION

Sys::VirtV2V::UserMessage provides an interface for displaying consistently formatted messages to a user. The string passed to user_message() should not contain a trailing newline. In English, the output will have the identifier prefixed if one was specified, and a newline appended.

METHODS

Sys::VirtV2V::UserMessage->set_identifier(identifier)
Set an identifier which will identify messages from this source from other sources. In English, this identifier will be prefixed to all messages with a colon and trailing space.
user_message(message)
Return a formatted user message.

message should not contain a prefix or a trailing newline.

Copyright (C) 2009 Red Hat Inc.

LICENSE

Please see the file COPYING.LIB for the full license.