Skip to content

Commit

Permalink
doc: Updating to newer generated man pages
Browse files Browse the repository at this point in the history
Signed-off-by: Tyler Erickson <tyler.erickson@seagate.com>
  • Loading branch information
vonericsen committed May 6, 2024
1 parent 7e5321d commit 75a7f75
Show file tree
Hide file tree
Showing 18 changed files with 791 additions and 334 deletions.
57 changes: 36 additions & 21 deletions docs/man/man8/openSeaChest_Basics.8
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH VERSION "8" "December 2023" "Version Info for openSeaChest_Basics:" "System Administration Utilities"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
.TH OPENSEACHEST_BASICS "1" "May 2024" "openSeaChest_Basics ==========================================================================================" "User Commands"
.SH NAME
Version \- =drive utilities
openSeaChest_Basics \- manual page for openSeaChest_Basics ==========================================================================================
.SH DESCRIPTION
==========================================================================================
.IP
openSeaChest_Basics \- openSeaChest drive utilities \- NVMe Enabled
Copyright (c) 2014\-2023 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
openSeaChest_Basics Version: 3.5.4\-6_2_0 X86_64
Build Date: Dec 1 2023
Today: Fri Dec 1 15:18:13 2023 User: current user
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
openSeaChest_Basics Version: 3.6.1\-7_1_0 X86_64
Build Date: May 6 2024
Today: Mon May 6 12:10:34 2024 User: current user
.PP
==========================================================================================
Usage
Expand Down Expand Up @@ -121,12 +121,6 @@ Using this option will force the current drive to
be treated as a SCSI drive. Only SCSI commands will
be used to talk to the drive.
.HP
\fB\-\-forceNVME\fR
.IP
Using this option will force the current drive to
be treated as a NVME drive. Only NVME commands will
be used to talk to the drive.
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
Show utility options and example usage (this output you see now)
Expand Down Expand Up @@ -566,15 +560,36 @@ Use one of these options to specify a range to trim
or unmap on a drive. A starting point must be specified
with the \fB\-\-trim\fR/\-\-unmapRange option.
.IP
Utility Version: 3.5.4
openSeaChest_Basics \- openSeaChest drive utilities \- NVMe Enabled
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
openSeaChest_Basics Version: 3.6.1\-7_1_0 X86_64
Build Date: May 6 2024
Today: Mon May 6 12:10:34 2024 User: current user
.PP
==========================================================================================
Version Info for openSeaChest_Basics:
.IP
Utility Version: 3.6.1
opensea\-common Version: 2.0.0
opensea\-transport Version: 6.2.0
opensea\-operations Version: 5.1.1
Build Date: Dec 1 2023
opensea\-transport Version: 7.1.0
opensea\-operations Version: 6.0.0
Build Date: May 6 2024
Compiled Architecture: X86_64
Detected Endianness: Little Endian
Compiler Used: GCC
Compiler Version: 7.5.0
Compiler Used: Clang
Compiler Version: 14.0.0
Operating System Type: Linux
Operating System Version: 4.15.0\-211
Operating System Name: Ubuntu 18.04.6 LTS
Operating System Version: 5.15.146\-0
Operating System Name: Ubuntu 22.04.4 LTS
.SH "SEE ALSO"
The full documentation for
.B openSeaChest_Basics
is maintained as a Texinfo manual. If the
.B info
and
.B openSeaChest_Basics
programs are properly installed at your site, the command
.IP
.B info openSeaChest_Basics
.PP
should give you access to the complete manual.
106 changes: 83 additions & 23 deletions docs/man/man8/openSeaChest_Configure.8
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH VERSION "8" "December 2023" "Version Info for openSeaChest_Configure:" "System Administration Utilities"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
.TH OPENSEACHEST_CONFIGURE "1" "May 2024" "openSeaChest_Configure ==========================================================================================" "User Commands"
.SH NAME
Version \- =drive utilities
openSeaChest_Configure \- manual page for openSeaChest_Configure ==========================================================================================
.SH DESCRIPTION
==========================================================================================
.IP
openSeaChest_Configure \- openSeaChest drive utilities \- NVMe Enabled
Copyright (c) 2014\-2023 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
openSeaChest_Configure Version: 2.5.0\-6_2_0 X86_64
Build Date: Dec 1 2023
Today: Fri Dec 1 15:18:13 2023 User: current user
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
openSeaChest_Configure Version: 2.7.1\-7_1_0 X86_64
Build Date: May 6 2024
Today: Mon May 6 12:10:34 2024 User: current user
.PP
==========================================================================================
Usage
Expand Down Expand Up @@ -124,12 +124,6 @@ Using this option will force the current drive to
be treated as a SCSI drive. Only SCSI commands will
be used to talk to the drive.
.HP
\fB\-\-forceNVME\fR
.IP
Using this option will force the current drive to
be treated as a NVME drive. Only NVME commands will
be used to talk to the drive.
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
Show utility options and example usage (this output you see now)
Expand Down Expand Up @@ -461,13 +455,24 @@ Note: Some products will support low, but not the ultra
.IP
low current spinup mode.
.TP
\fB\-\-puisFeature\fR [ enable | disable ]
\fB\-\-puisFeature\fR [ info | spinup | enable | disable ]
(SATA Only)
.IP
Use this option to enable or disable the power up in standby
(PUIS) feature on SATA drives.
Arguments:
.TP
info
\- display information about the PUIS support on the device
.TP
spinup
\- issue the PUIS spinup set features command to spin up
.TP
the device to active/idle state.
enable \- enable the PUIS feature using setfeatures command
disable \- disable the PUIS feature using setfeatures command
.TP
Note: If this is configured on the drive with a jumper, this
.IP
command will fail.
.IP
Note2: Not all products support this feature.
Expand Down Expand Up @@ -565,6 +570,40 @@ The maximum time that can be specified is 1 hour, 49 minutes, 13 seconds
Using the "default" argument restores default settings.
Note: On some SAT HBAs/bridges, status will not be able to be
determined due to HBA/bridge limitations.
.TP
\fB\-\-wrv\fR [ info | all | vendor | # | disable ]
(SATA Only)
.IP
This option can report the current configuration of the
ATA Write\-Read\-Verify feature, enable the feature, or
disable the feature.
Enabling this feature instructs the device to perform a
verification of all data after it has been written.
Enabling this may result in lower device performance.
If write caching is enabled, this feature may return
completion before writing to the medium and verifying
the medium. If Write caching is disabled, the write and
verification must complete before returning command status.
Argument usage:
.TP
info
\- Display the current status of the feature
.TP
all
\- set verification on for all written sectors
.TP
vendor
\- set verification for the 1st vendor specific
.IP
number of sectors.
.TP
#
\- Perform verification for the first user defined
.TP
number of sectors. Note: This is rounded up to the
nearest 1024 sectors. Max value of 261120 sectors.
.IP
disable \- disable the Write\-Read\-Verify feature.
.IP
SAS Only:
========
Expand Down Expand Up @@ -750,15 +789,36 @@ the provisioning again. This command erases all data between
the new maxLBA specified and the current maxLBA of the device.
using a TRIM/UNMAP command.
.IP
Utility Version: 2.5.0
openSeaChest_Configure \- openSeaChest drive utilities \- NVMe Enabled
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
openSeaChest_Configure Version: 2.7.1\-7_1_0 X86_64
Build Date: May 6 2024
Today: Mon May 6 12:10:34 2024 User: current user
.PP
==========================================================================================
Version Info for openSeaChest_Configure:
.IP
Utility Version: 2.7.1
opensea\-common Version: 2.0.0
opensea\-transport Version: 6.2.0
opensea\-operations Version: 5.1.1
Build Date: Dec 1 2023
opensea\-transport Version: 7.1.0
opensea\-operations Version: 6.0.0
Build Date: May 6 2024
Compiled Architecture: X86_64
Detected Endianness: Little Endian
Compiler Used: GCC
Compiler Version: 7.5.0
Compiler Used: Clang
Compiler Version: 14.0.0
Operating System Type: Linux
Operating System Version: 4.15.0\-211
Operating System Name: Ubuntu 18.04.6 LTS
Operating System Version: 5.15.146\-0
Operating System Name: Ubuntu 22.04.4 LTS
.SH "SEE ALSO"
The full documentation for
.B openSeaChest_Configure
is maintained as a Texinfo manual. If the
.B info
and
.B openSeaChest_Configure
programs are properly installed at your site, the command
.IP
.B info openSeaChest_Configure
.PP
should give you access to the complete manual.
35 changes: 33 additions & 2 deletions docs/man/man8/openSeaChest_Defect.8
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ openSeaChest_Defect \- openSeaChest drive utilities \- NVMe Enabled
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
openSeaChest_Defect Version: 0.9.0\-7_1_0 X86_64
Build Date: May 6 2024
Today: Mon May 6 11:25:27 2024 User: current user
Today: Mon May 6 12:10:34 2024 User: current user
.PP
==========================================================================================
Usage
Expand Down Expand Up @@ -247,6 +247,37 @@ Defects log page from SBC4 or later
Use this option to show the pending defect list
as it is reported by the drive.
NOTE: SBC4 pending log required for SAS support.
.IP
SAS Only:
.HP
\fB\-\-defectFormat\fR [ # | shortBlock | longBlock | xbfi | xchs | bfi | chs ] (SAS Only)
.IP
This option set the format of the defects to output.
Not all drives will support all defect modes!
SSDs will only support block modes!
Arguments: (name | #)
.IP
shortBlock | 0 \- show the defects in short block address mode (drives < 32bit LBA)
xbfi | 1 \- show the defects in extended bytes from index mode
xchs | 2 \- show the defects in extended physical cylinder\-head\-sector mode
longBlock | 3 \- show the defects in long block address mode (drives > 32bit LBA)
bfi | 4 \- show the defects in bytes from index mode
chs | 5 \- show the defects in physical cylinder\-head\-sector mode
.TP
\fB\-\-showSCSIDefects\fR [ p | g | pg ]
(SAS Only)
.IP
This option will display the SCSI defects on the screen.
The arguments to this will tell whether to get the grown,
primary, or primary and grown defects from the drive.
Use the \fB\-\-defectFormat\fR option to specify the mode to display the defects.
If no mode is specified, physical cylinder\-head\-sector mode is assumed
Arguments:
.IP
p \- use this option to pull and display the primary (factory) defects
g \- use this option to pull and display the grown (reallocated) defects
.IP
The above options can be combined to pull and display both defect lists.
.PP
Data Destructive Commands (Seagate only)
========================================
Expand Down Expand Up @@ -342,7 +373,7 @@ openSeaChest_Defect \- openSeaChest drive utilities \- NVMe Enabled
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
openSeaChest_Defect Version: 0.9.0\-7_1_0 X86_64
Build Date: May 6 2024
Today: Mon May 6 11:25:27 2024 User: current user
Today: Mon May 6 12:10:34 2024 User: current user
.PP
==========================================================================================
Version Info for openSeaChest_Defect:
Expand Down
Loading

0 comments on commit 75a7f75

Please sign in to comment.