Anonymous avatar Anonymous committed 24ee957

Regenerated README file

Comments (0)

Files changed (1)

     KDE Wallet.
 
 VERSION
-    Version 0.2001
+    Version 0.2002
 
 SYNOPSIS
     KDE Wallet based implementation of Passwd::Keyring.
 
         use Passwd::Keyring::KDEWallet;
 
-        my $keyring = Passwd::Keyring::KDEWallet->new(app=>"My beautiful app", group=>"My app web passwords");
+        my $keyring = Passwd::Keyring::KDEWallet->new(
+             app=>"blahblah scraper",
+             group=>"Johnny web scrapers",
+        );
 
-        $keyring->set_password("John", "verysecret", "my-pseudodomain");
-        # And later, on next run maybe
-        my $password = $keyring->get_password("John", "my-pseudodomain");
-        # plus
-        $keyring->clear_password("John", "my-pseudodomain");
+        my $username = "John";  # or get from .ini, or from .argv...
+
+        my $password = $keyring->get_password($username, "blahblah.com");
+        unless( $password ) {
+            $password = <somehow interactively prompt for password>;
+
+            # securely save password for future use
+            $keyring->set_password($username, "blahblah.com");
+        }
+
+        login_somewhere_using($username, $password);
+        if( password_was_wrong ) {
+            $keyring->clear_password($username, "blahblah.com");
+        }
 
     Note: see Passwd::Keyring::Auto::KeyringAPI for detailed comments on
     keyring method semantics (this document is installed with
-    Passwd::Keyring::Auto package).
+    `Passwd::Keyring::Auto' package).
 
 SUBROUTINES/METHODS
-  new
+  new(app=>'app name', group=>'passwords folder')
     Initializes the processing. Croaks if kwallet does not seem to be
     available.
 
+    Handled named parameters:
+
+    - app - symbolic application name (used in "Application .... is asking
+    to open the wallet" KDE Wallet prompt)
+
+    - group - name for the password group (used as KDE Wallet folder name)
+
   set_password(username, password, domain)
     Sets (stores) password identified by given domain for given user
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.