From fe58a46838d006cb08878940eb7a7776e0e3598c Mon Sep 17 00:00:00 2001
From: dlavigne <dru@freebsd.org>
Date: Wed, 27 Apr 2016 09:34:06 -0400
Subject: [PATCH] Doc pkg_autoremove action.

---
 api/classes/pkg.rst | 52 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 50 insertions(+), 2 deletions(-)

diff --git a/api/classes/pkg.rst b/api/classes/pkg.rst
index 58afbe5..cc69beb 100644
--- a/api/classes/pkg.rst
+++ b/api/classes/pkg.rst
@@ -21,7 +21,7 @@ Every pkg class request contains the following parameters:
 |                                 |               |                                                                                                                      |
 +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
 | action                          |               | supported actions include "pkg_info", "pkg_search", "list_categories", "list_repos", "pkg_audit", "pkg_upgrade",     |
-|                                 |               | "pkg_check_upgrade", "pkg_update", "pkg_lock", "pkg_unlock", "pkg_install", and "pkg_remove"                         |
+|                                 |               | "pkg_check_upgrade", "pkg_update", "pkg_lock", "pkg_unlock", "pkg_install", "pkg_remove", and "pkg_autoremove"       |
 |                                 |               |                                                                                                                      |
 +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
 
@@ -1156,4 +1156,52 @@ The uninstall messages will be returned as a dispatcher event. Refer to the :ref
       "state" : "finished"
       }
     }
- } 
\ No newline at end of file
+ } 
+ 
+.. index:: pkg_autoremove, pkg
+
+.. _Prune Packages:
+
+Prune Packages
+==============
+
+The "pkg_autoremove" action prunes all orphaned packages on the system.
+
+**REST Request**
+
+.. code-block:: json
+
+ PUT /sysadm/pkg
+ {
+  "action" : "pkg_autoremove"
+ }
+
+**WebSocket Request**
+
+.. code-block:: json
+
+ {
+  "args" : {
+     "action" : "pkg_autoremove"
+  },
+  "name" : "pkg",
+  "namespace" : "sysadm",
+  "id" : "fooid"
+ }
+
+**Response**
+
+.. code-block:: json
+
+ {
+ "args": {
+   "pkg_autoremove": {
+     "proc_cmd": "pkg autoremove -y",
+     "proc_id": "sysadm_pkg_autoremove-{19ace7c9-0d83-4a0d-9249-0b56cb105762}",
+     "status": "pending"
+   }
+ },
+ "id": "fooid",
+ "name": "response",
+ "namespace": "sysadm"
+ }
\ No newline at end of file