summaryrefslogtreecommitdiff
path: root/builtins/suspend.def
diff options
context:
space:
mode:
Diffstat (limited to 'builtins/suspend.def')
-rw-r--r--builtins/suspend.def36
1 files changed, 21 insertions, 15 deletions
diff --git a/builtins/suspend.def b/builtins/suspend.def
index ea86ae2..8711e68 100644
--- a/builtins/suspend.def
+++ b/builtins/suspend.def
@@ -1,23 +1,22 @@
This file is suspend.def, from which is created suspend.c.
It implements the builtin "suspend" in Bash.
-Copyright (C) 1987-2003 Free Software Foundation, Inc.
+Copyright (C) 1987-2009 Free Software Foundation, Inc.
This file is part of GNU Bash, the Bourne Again SHell.
-Bash is free software; you can redistribute it and/or modify it under
-the terms of the GNU General Public License as published by the Free
-Software Foundation; either version 2, or (at your option) any later
-version.
+Bash is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
-Bash is distributed in the hope that it will be useful, but WITHOUT ANY
-WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
-for more details.
+Bash is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
-You should have received a copy of the GNU General Public License along
-with Bash; see the file COPYING. If not, write to the Free Software
-Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA.
+You should have received a copy of the GNU General Public License
+along with Bash. If not, see <http://www.gnu.org/licenses/>.
$PRODUCES suspend.c
@@ -25,9 +24,16 @@ $BUILTIN suspend
$DEPENDS_ON JOB_CONTROL
$FUNCTION suspend_builtin
$SHORT_DOC suspend [-f]
-Suspend the execution of this shell until it receives a SIGCONT
-signal. The `-f' if specified says not to complain about this
-being a login shell if it is; just suspend anyway.
+Suspend shell execution.
+
+Suspend the execution of this shell until it receives a SIGCONT signal.
+Unless forced, login shells cannot be suspended.
+
+Options:
+ -f force the suspend, even if the shell is a login shell
+
+Exit Status:
+Returns success unless job control is not enabled or an error occurs.
$END
#include <config.h>