From 106ebd1ad028a351fd8a1dec8d9bb2483e9adc4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rud=C3=A1=20Moura?= Date: Fri, 15 Jan 2016 11:55:44 -0200 Subject: [PATCH] Update documentation. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Rudá Moura --- LICENSE | 2 +- README | 18 +++++++++--------- poof.1 | 10 ++++++---- poof.py | 21 ++++++++++++--------- 4 files changed, 28 insertions(+), 23 deletions(-) diff --git a/LICENSE b/LICENSE index 977a8c7..7b74a3e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2011-2013, Rudá Moura +Copyright (c) 2011-2016, Rudá Moura All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/README b/README index 4ded8a7..84bee80 100644 --- a/README +++ b/README @@ -1,23 +1,23 @@ -Poof is a command line utility to list or remove Mac OS X packages. +Poof is a command line utility to list and uninstall/remove OS X packages. -NO WARRANTY! - -DON'T BLAME ME if you destroy your Mac OS X installation, NEVER REMOVE com.apple.* packages unless you know what are you doing. +*NO WARRANTY* DON'T BLAME ME if you destroy your installation! +NEVER REMOVE com.apple.* packages unless you know what you are doing. How it works: -First by removing files and directories and then forgetting the metadata about the package (the receipt data). +It first removes all files and directories declared by the package and +then forget the metadata (the receipt data). -Install: +Get poof: $ curl -O https://raw.github.com/ruda/poof/master/poof.py $ chmod +x poof.py Usage: -List packages (but ignore from Apple). +List packages (but ignore all from Apple). - $ ./poof.py | grep -v apple + $ ./poof.py | grep -v com.apple.pkg com.accessagility.wifiscanner com.adobe.pkg.FlashPlayer com.amazon.Kindle @@ -33,5 +33,5 @@ List packages (but ignore from Apple). Remove FlashPlayer (com.adobe.pkg.FlashPlayer). $ sudo ./poof.py com.adobe.pkg.FlashPlayer - (Some error messages regarding directory is not empty) + ... Forgot package 'com.adobe.pkg.FlashPlayer' on '/'. diff --git a/poof.1 b/poof.1 index a91da52..9e16d1b 100644 --- a/poof.1 +++ b/poof.1 @@ -1,16 +1,18 @@ .\" Manpage for poof -.Dd January 5, 2013 +.Dd January 15, 2016 .Dt poof 1 -.Os Mac OS X +.Os OS X .Sh NAME .Nm poof -.Nd List or remove Mac OS X packages +.Nd List and uninstall/remove OS X packages .Sh SYNOPSIS .Nm Ar package-id .Sh DESCRIPTION The .Nm -command line utility lists or removes Mac OS X packages in a low-level manner, by removing files and directories and then forgetting the metadata about the package (the receipt data). +command line utility list and uninstall/remove OS X packages in a low-level manner, +it first removes all files and directories declared by the package and +then forget the metadata (the receipt data). .Sh EXAMPLES List packages (but skip from Apple): .Dl "./poof.py | grep -v com.apple.pkg" diff --git a/poof.py b/poof.py index 9a31a51..4c1552e 100755 --- a/poof.py +++ b/poof.py @@ -1,22 +1,25 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # -# Poof: List or remove Mac OS X packages -# Copyright (c) 2011-2013 Rudá Moura +# Poof: List and uninstall/remove OS X packages +# Copyright (c) 2011-2016 Rudá Moura # -"""Poof is a command line utility to list or remove Mac OS X packages. +"""Poof is a command line utility to list and uninstall/remove OS X packages. -NO WARRANTY! +*NO WARRANTY* DON'T BLAME ME if you destroy your installation! +NEVER REMOVE com.apple.* packages unless you know what you are doing. -DON'T BLAME ME if you destroy your Mac OS X installation, -NEVER REMOVE com.apple.* packages unless you know what are you doing. +How it works: + +It first removes all files and directories declared by the package and +then forget the metadata (the receipt data). Usage: -List packages (but ignore from Apple). +List packages (but ignore all from Apple). - $ ./poof.py | grep -v apple + $ ./poof.py | grep -v com.apple.pkg com.accessagility.wifiscanner com.adobe.pkg.FlashPlayer com.amazon.Kindle @@ -32,7 +35,7 @@ Remove FlashPlayer (com.adobe.pkg.FlashPlayer). $ sudo ./poof.py com.adobe.pkg.FlashPlayer - (Some error messages regarding directory is not empty) + ... Forgot package 'com.adobe.pkg.FlashPlayer' on '/'. """