From c321dec104a199b5858e940eff4e1fbcebfb42c6 Mon Sep 17 00:00:00 2001
From: Thierry Vignaud <tv@mageia.org>
Date: Mon, 25 Feb 2013 17:57:06 +0000
Subject: sync urpm object doc with code

---
 urpm.pm | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

(limited to 'urpm.pm')

diff --git a/urpm.pm b/urpm.pm
index 309b8e19..e1b7bba8 100644
--- a/urpm.pm
+++ b/urpm.pm
@@ -79,6 +79,52 @@ B<media>: [ {
    unknown_media_info => bool, 
  } ],
 
+B<options>: hashref of urpm options
+
+several paths:
+
+=over
+
+B<config>: path of  urpmi.cfg (/etc/urpmi/urpmi.cfg)
+
+B<mediacfgdir>: path of mediacfg.d (/etc/urpmi/mediacfg.d)
+
+B<skiplist>: path of skip.list (/etc/urpmi/skip.list),
+
+B<instlist>: path of inst.list (/etc/urpmi/inst.list),
+
+B<prefer_list>: path of prefer.list (/etc/urpmi/prefer.list),
+
+B<prefer_vendor_list>: path of prefer.vendor.list (/etc/urpmi/prefer.vendor.list),
+
+B<private_netrc>: path of netrc (/etc/urpmi/netrc),
+
+B<statedir>: state directory (/var/lib/urpmi),
+
+B<cachedir>: cache directory (/var/cache/urpmi),
+
+B<root>: path of the rooted system (when using global urpmi config),
+
+B<urpmi_root>: path of the rooted system (when both urpmi & rpmdb are chrooted)
+
+=back
+
+Several subs:
+
+=over
+
+B<fatal>: sub for relaying fatal errors (should popup in GUIes)
+
+B<error>: sub for relaying other errors
+
+B<log>: sub for relaying messages if --verbose
+
+B<print>: sub for always displayed messages, enable to redirect output for eg: installer
+
+B<info>: sub for messages displayed unless --quiet
+
+=back
+
 All C<URPM> methods are available on an urpm object.
 
 =cut
@@ -107,6 +153,12 @@ sub new {
     $self;
 }
 
+=item urpm->new_parse_cmdline()
+
+Like urpm->new but also parse the command line and parse the configuration file.
+
+=cut
+
 sub new_parse_cmdline {
     my ($class) = @_;
     my $urpm = $class->new;
-- 
cgit v1.2.1