Skip to contentSkip to conversation

reboot.2: Mention RB_POWER_OFF

PATCH In review Elie De Brauwer 2 participants 4 messages Sep 30, 2013 – Dec 28, 2013 2 messages not in the archive Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 reboot.2: Mention RB_POWER_OFF

The manpage did not mention RB_POWER_OFF which is the glibc symbolic name for LINUX_REBOOT_CMD_POWER_OFF.

edb@lapedb:/usr/include$ cat x86_64-linux-gnu/sys/reboot.h  | grep POWER_OFF
 define RB_POWER_OFF	0x4321fedc
---
 man2/reboot.2 |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
man2/reboot.2 +1 -1
index b25d62c..0ed6355 100644
@@ -115,7 +115,7 @@ This option is available only if the kernel was configured with
 .BR CONFIG_KEXEC .
 .TP
 .B LINUX_REBOOT_CMD_POWER_OFF
-(0x4321fedc; since 2.1.30).
+(RB_POWER_OFF, 0x4321fedc; since 2.1.30).
 The message "Power down." is printed, the system is stopped,
 and all power is removed from the system, if possible.
 If not preceded by a
Signature · 6 lines
1.7.10.4

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): 1380566504-9669-1-git-send-email-eliedebrauwer-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org

#2 lore raw

PATCH 2/2 reboot.2: Add documentation of LINUX_REBOOT_SW_SUSPEND

When reboot() is called with LINUX_REBOOT_SW_SUSPEND and CONFIG_HIBERNATION is set, the hibernation process will be called.

E.g kernel/reboot.c contains:

267#ifdef CONFIG_HIBERNATION
268 case LINUX_REBOOT_CMD_SW_SUSPEND:
269 ret = hibernate();
270 break;
271#endif

---
 man2/reboot.2 |   17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)
man2/reboot.2 +12 -5
index 0ed6355..d4a5a0e 100644
@@ -25,7 +25,7 @@
 .\" Modified, 27 May 2004, Michael Kerrisk <[email protected]>
 .\"     Added notes on capability requirements
 .\"
-.TH REBOOT 2 2010-10-31 "Linux" "Linux Programmer's Manual"
+.TH REBOOT 2 2013-09-30 "Linux" "Linux Programmer's Manual"
 .SH NAME
 reboot \- reboot or enable/disable Ctrl-Alt-Del
 .SH SYNOPSIS
@@ -101,21 +101,22 @@ the action associated with
 .BR LINUX_REBOOT_CMD_RESTART .
 .TP
 .B LINUX_REBOOT_CMD_HALT
-(RB_HALT_SYSTEM, 0xcdef0123; since 1.1.76).
+(RB_HALT_SYSTEM, 0xcdef0123; since Linux 1.1.76).
 The message "System halted." is printed, and the system is halted.
 Control is given to the ROM monitor, if there is one.
 If not preceded by a
 .BR sync (2),
 data will be lost.
 .TP
-.BR LINUX_REBOOT_CMD_KEXEC " (since Linux 2.6.13)"
+.BR LINUX_REBOOT_CMD_KEXEC 
+(0x45584543; since Linux 2.6.13).
 Execute a kernel that has been loaded earlier with
 .BR kexec_load (2).
 This option is available only if the kernel was configured with
 .BR CONFIG_KEXEC .
 .TP
 .B LINUX_REBOOT_CMD_POWER_OFF
-(RB_POWER_OFF, 0x4321fedc; since 2.1.30).
+(RB_POWER_OFF, 0x4321fedc; since Linux 2.1.30).
 The message "Power down." is printed, the system is stopped,
 and all power is removed from the system, if possible.
 If not preceded by a
@@ -131,7 +132,7 @@ If not preceded by a
 data will be lost.
 .TP
 .B LINUX_REBOOT_CMD_RESTART2
-(0xa1b2c3d4; since 2.1.30).
+(0xa1b2c3d4; since Linux 2.1.30).
 The message "Restarting system with command \(aq%s\(aq" is printed,
 and a restart (using the command string given in
 .IR arg )
@@ -139,6 +140,12 @@ is performed immediately.
 If not preceded by a
 .BR sync (2),
 data will be lost.
+.TP
+.BR LINUX_REBOOT_CMD_SW_SUSPEND 
+(0xd000fce2; since Linux 2.5.18).
+The system is suspended (hibernated) to disk.
+This option is available only if the kernel was configured with
+.BR CONFIG_HIBERNATION .
 .LP
 Only the superuser may call
 .BR reboot ().
Signature · 6 lines
1.7.10.4

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): 1380566504-9669-2-git-send-email-eliedebrauwer-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org

#4 lore raw

Re: [PATCH 2/2] reboot.2: Add documentation of LINUX_REBOOT_SW_SUSPEND

Quoted 67 lines · Elie De Brauwer

When reboot() is called with LINUX_REBOOT_SW_SUSPEND and CONFIG_HIBERNATION is set, the hibernation process will be called.

E.g kernel/reboot.c contains:

267#ifdef CONFIG_HIBERNATION
268 case LINUX_REBOOT_CMD_SW_SUSPEND:
269 ret = hibernate();
270 break;
271#endif

---
 man2/reboot.2 |   17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)
man2/reboot.2 +6 -5
index 0ed6355..d4a5a0e 100644
@@ -25,7 +25,7 @@
 .\" Modified, 27 May 2004, Michael Kerrisk <[email protected]>
 .\"     Added notes on capability requirements
 .\"
-.TH REBOOT 2 2010-10-31 "Linux" "Linux Programmer's Manual"
+.TH REBOOT 2 2013-09-30 "Linux" "Linux Programmer's Manual"
 .SH NAME
 reboot \- reboot or enable/disable Ctrl-Alt-Del
 .SH SYNOPSIS
@@ -101,21 +101,22 @@ the action associated with
 .BR LINUX_REBOOT_CMD_RESTART .
 .TP
 .B LINUX_REBOOT_CMD_HALT
-(RB_HALT_SYSTEM, 0xcdef0123; since 1.1.76).
+(RB_HALT_SYSTEM, 0xcdef0123; since Linux 1.1.76).
 The message "System halted." is printed, and the system is halted.
 Control is given to the ROM monitor, if there is one.
 If not preceded by a
 .BR sync (2),
 data will be lost.
 .TP
-.BR LINUX_REBOOT_CMD_KEXEC " (since Linux 2.6.13)"
+.BR LINUX_REBOOT_CMD_KEXEC 
+(0x45584543; since Linux 2.6.13).
 Execute a kernel that has been loaded earlier with
 .BR kexec_load (2).
 This option is available only if the kernel was configured with
 .BR CONFIG_KEXEC .
 .TP
 .B LINUX_REBOOT_CMD_POWER_OFF
-(RB_POWER_OFF, 0x4321fedc; since 2.1.30).
+(RB_POWER_OFF, 0x4321fedc; since Linux 2.1.30).
 The message "Power down." is printed, the system is stopped,
 and all power is removed from the system, if possible.
 If not preceded by a
@@ -131,7 +132,7 @@ If not preceded by a
 data will be lost.
 .TP
 .B LINUX_REBOOT_CMD_RESTART2
-(0xa1b2c3d4; since 2.1.30).
+(0xa1b2c3d4; since Linux 2.1.30).
 The message "Restarting system with command \(aq%s\(aq" is printed,
 and a restart (using the command string given in
 .IR arg )
@@ -139,6 +140,12 @@ is performed immediately.
 If not preceded by a
 .BR sync (2),

man2/reboot.2 is performed immediately. · line 151

Quoted 10 lines
man2/reboot.2 +6 -0
 data will be lost.
+.TP
+.BR LINUX_REBOOT_CMD_SW_SUSPEND 
+(0xd000fce2; since Linux 2.5.18).
+The system is suspended (hibernated) to disk.
+This option is available only if the kernel was configured with
+.BR CONFIG_HIBERNATION .
 .LP
 Only the superuser may call
 .BR reboot ().

Thanks, Elie. Applied.

Cheers,

Michael

Signature · 6 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
#5 lore raw
In reply to a message not in the archive
Quoted 2 lines · Elie De Brauwer

The manpage did not mention RB_POWER_OFF which is the glibc symbolic name for LINUX_REBOOT_CMD_POWER_OFF.

Thanks, Elie. Applied.

Cheers,

Michael

Quoted 22 lines
edb@lapedb:/usr/include$ cat x86_64-linux-gnu/sys/reboot.h  | grep POWER_OFF
 define RB_POWER_OFF	0x4321fedc
---
 man2/reboot.2 |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
man2/reboot.2 +1 -1
index b25d62c..0ed6355 100644
@@ -115,7 +115,7 @@ This option is available only if the kernel was configured with
 .BR CONFIG_KEXEC .
 .TP
 .B LINUX_REBOOT_CMD_POWER_OFF
-(0x4321fedc; since 2.1.30).
+(RB_POWER_OFF, 0x4321fedc; since 2.1.30).
 The message "Power down." is printed, the system is stopped,
 and all power is removed from the system, if possible.
 If not preceded by a
Signature · 6 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html