]> code.delx.au - refind/blobdiff - docs/man/refind-mkdefault.8
Version 0.10.5 release.
[refind] / docs / man / refind-mkdefault.8
index ae7818e5ea838c11242e63209bb6a156388831a5..46338644b00c8f90bdb294aa79121f27134b15f5 100644 (file)
@@ -1,7 +1,7 @@
 .\" Copyright 2016 Roderick W. Smith (rodsmith@rodsbooks.com)
 .\" May be distributed under the GNU Free Documentation License version 1.3 or
 any later version
-.TH "REFIND-MKDEFAULT" "8" "0.10.3" "Roderick W. Smith" "rEFInd Manual"
+.TH "REFIND-MKDEFAULT" "8" "0.10.5" "Roderick W. Smith" "rEFInd Manual"
 .SH "NAME"
 refind-mkdefault \- Set rEFInd as the default EFI boot option
 .SH "SYNOPSIS"
@@ -75,6 +75,36 @@ low in risk.
 Instead of searching for the string \fBrefind\fR in \fIefibootmgr\fR output
 as a way to identify rEFInd, search for the string \fBname\fR.
 
+.SH "RETURN VALUES"
+
+\fIrefind-mkdefault\fR returns the following values:
+
+.TP
+.B 0
+The script completed successfully, which can mean either that no change was
+necessary or that the call to \fIefibootmgr\fR returned a success code.
+
+.TP
+.B 1
+EFI boot order variables are available, and a rEFInd entry was found, but
+the call to \fIefibootmgr\fR returned a failure code.
+
+.TP
+.B 2
+EFI boot entries are not available. This condition is often an indication of
+a buggy EFI or badly damaged NVRAM contents.
+
+.TP
+.B 3
+No rEFInd entry could be found in the list of boot options, and so
+no changes were made to the boot order list.
+
+.TP
+.B 4
+The script could not run because of OS issues -- the OS was not Linux,
+the \fIefibootmgr\fR utility was not available, or the script was not run
+as \fIroot\fR.
+
 .SH "LIMITATIONS"
 
 .TP