Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
Signed-off-by: Rudá Moura <[email protected]>
  • Loading branch information
ruda committed Jan 15, 2016
1 parent 0598d3d commit 106ebd1
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 23 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2011-2013, Rudá Moura <[email protected]>
Copyright (c) 2011-2016, Rudá Moura <[email protected]>
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Expand Down
18 changes: 9 additions & 9 deletions README
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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 '/'.
10 changes: 6 additions & 4 deletions poof.1
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
21 changes: 12 additions & 9 deletions poof.py
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Poof: List or remove Mac OS X packages
# Copyright (c) 2011-2013 Rudá Moura <[email protected]>
# Poof: List and uninstall/remove OS X packages
# Copyright (c) 2011-2016 Rudá Moura <[email protected]>
#

"""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
Expand All @@ -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 '/'.
"""

Expand Down

0 comments on commit 106ebd1

Please sign in to comment.