Bring references to ipcclean in sync with reality.
authorPeter Eisentraut
Tue, 4 Sep 2001 00:22:34 +0000 (00:22 +0000)
committerPeter Eisentraut
Tue, 4 Sep 2001 00:22:34 +0000 (00:22 +0000)
doc/src/sgml/ref/ipcclean.sgml
src/backend/storage/ipc/ipc.c

index cb468f8c615c5ecfb49a61b7d9de9ea7a1e40920..7c4fc5647e76c4688ddd91f547e033c6db74c8ac 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -28,35 +28,36 @@ Postgres documentation
  
   Description
   
-   ipcclean
-   cleans up shared memory and semaphore space from aborted backends by
-   deleting all instances owned by user postgres.
-   Only the DBA
-   should execute this program as it can cause bizarre behavior (i.e.,
-   crashes) if run during multi-user execution.  This program should be
-   executed if messages such as
-
-   
-semget: No space left on device
-   
-
-   are encountered when starting up the 
-   postmaster or the backend server.
+   ipcclean removes all shared memory segments and
+   semaphore sets owned by the current user.  It is intended to be
+   used for cleaning up after a crashed
+   PostgreSQL server (
+   linkend="app-postmaster">).  Note that immediately restarting the
+   server will also clean up shared memory and semaphores, so this
+   command is of little real utility.
   
 
   
-   If this command is executed while postmaster
-   is running, the shared memory and semaphores allocated by the
-   postmaster
-   will be deleted.  This will result in a general failure of the
-   backend servers started by that
+   Only the database administrator should execute this program as it
+   can cause bizarre behavior (i.e., crashes) if run during multiuser
+   execution.  If this command is executed while a
+   postmaster is running, the shared memory
+   and semaphores allocated by the
+   postmaster will be deleted.  This will
+   result in a general failure of the backend servers started by that
    postmaster.
   
+
+  Notes
 
   
-   This script is a hack, but in the many years since it was written, no
-   one has come up with an equally effective and portable solution.
-   Suggestions are welcome.
+   This script is a hack, but in the many years since it was written,
+   no one has come up with an equally effective and portable solution.
+   Since the postmaster can now clean up by
+   itself, it is unlikely that ipcclean will be
+   improved upon in the future.
   
 
   
@@ -66,6 +67,7 @@ semget: No space left on device
    Therefore, it may not work on your particular OS.
   
  
+