Skip to content

Commit 0e067d7

Browse files
vonericsenvonericsen
committed
doc: Updating openSeaChest docs and man pages
Signed-off-by: Tyler Erickson <[email protected]>
1 parent 650389e commit 0e067d7

36 files changed

+479
-178
lines changed

‎docs/man/man8/openSeaChest_Basics.8‎

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
2-
.TH OPENSEACHEST_BASICS "1" "July 2024" "openSeaChest_Basics ==========================================================================================" "User Commands"
2+
.TH OPENSEACHEST_BASICS "1" "August 2024" "openSeaChest_Basics ==========================================================================================" "User Commands"
33
.SH NAME
44
openSeaChest_Basics \- manual page for openSeaChest_Basics ==========================================================================================
55
.SH DESCRIPTION
66
==========================================================================================
77
.IP
88
openSeaChest_Basics \- openSeaChest drive utilities \- NVMe Enabled
99
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
10-
openSeaChest_Basics Version: 3.6.1\-8_0_0 X86_64
11-
Build Date: May 31 2024
12-
Today: Tue Jul 30 20:33:33 2024 User: current user
10+
openSeaChest_Basics Version: 3.6.2\-8_0_0 X86_64
11+
Build Date: Aug 26 2024
12+
Today: 20240828T143604 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -50,7 +50,9 @@ openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-trim\fR 0
5050
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-trim\fR 1000 \fB\-\-trimRange\fR 2000
5151
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-provision\fR 134217728
5252
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-setMaxLBA\fR 134217728
53+
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-setMaxLBA\fR 134217728 \fB\-\-changeIdString\fR
5354
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-restoreMaxLBA\fR
55+
openSeaChest_Basics \fB\-d\fR /dev/sg<#> \fB\-\-capacityModelNumberMapping\fR
5456
.PP
5557
Return codes
5658
============
@@ -279,6 +281,16 @@ is available.
279281
Use this option
280282
to issue a fast scan on the specified drive.
281283
.HP
284+
\fB\-\-capacityModelNumberMapping\fR
285+
.IP
286+
Use this option to display the capacity model number mapping
287+
TBD
288+
.HP
289+
\fB\-\-changeIdString\fR
290+
.IP
291+
Use this option to change ID string according to capacity \- model number
292+
mapping. Need to use together with \fB\-\-setMaxLBA\fR or \fB\-\-restoreMaxLBA\fR
293+
.HP
282294
\fB\-\-checkPowerMode\fR
283295
.IP
284296
Get the current power mode of a drive.
@@ -562,22 +574,22 @@ with the \fB\-\-trim\fR/\-\-unmapRange option.
562574
.IP
563575
openSeaChest_Basics \- openSeaChest drive utilities \- NVMe Enabled
564576
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
565-
openSeaChest_Basics Version: 3.6.1\-8_0_0 X86_64
566-
Build Date: May 31 2024
567-
Today: Tue Jul 30 20:33:33 2024 User: current user
577+
openSeaChest_Basics Version: 3.6.2\-8_0_0 X86_64
578+
Build Date: Aug 26 2024
579+
Today: 20240828T143604 User: current user
568580
.PP
569581
==========================================================================================
570582
Version Info for openSeaChest_Basics:
571583
.IP
572-
Utility Version: 3.6.1
573-
opensea\-common Version: 3.0.0
584+
Utility Version: 3.6.2
585+
opensea\-common Version: 4.0.0
574586
opensea\-transport Version: 8.0.0
575-
opensea\-operations Version: 7.0.0
576-
Build Date: May 31 2024
587+
opensea\-operations Version: 8.0.0
588+
Build Date: Aug 26 2024
577589
Compiled Architecture: X86_64
578590
Detected Endianness: Little Endian
579591
Compiler Used: GCC
580-
Compiler Version: 11.2.1
592+
Compiler Version: 11.4.0
581593
Operating System Type: Linux
582594
Operating System Version: 5.15.153\-1
583595
Operating System Name: Ubuntu 22.04.4 LTS

‎docs/man/man8/openSeaChest_Configure.8‎

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
2-
.TH OPENSEACHEST_CONFIGURE "1" "July 2024" "openSeaChest_Configure ==========================================================================================" "User Commands"
2+
.TH OPENSEACHEST_CONFIGURE "1" "August 2024" "openSeaChest_Configure ==========================================================================================" "User Commands"
33
.SH NAME
44
openSeaChest_Configure \- manual page for openSeaChest_Configure ==========================================================================================
55
.SH DESCRIPTION
@@ -8,8 +8,8 @@ openSeaChest_Configure \- manual page for openSeaChest_Configure ===============
88
openSeaChest_Configure \- openSeaChest drive utilities \- NVMe Enabled
99
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
1010
openSeaChest_Configure Version: 2.7.1\-8_0_0 X86_64
11-
Build Date: May 31 2024
12-
Today: Tue Jul 30 20:33:33 2024 User: current user
11+
Build Date: Aug 26 2024
12+
Today: 20240828T143604 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -50,6 +50,8 @@ openSeaChest_Configure \fB\-d\fR /dev/sg<#> \fB\-\-scsiMPRestore\fR 3Fh\-FFh
5050
openSeaChest_Configure \fB\-d\fR /dev/sg<#> \fB\-\-setSCSIMP\fR 08:2:2:1=0
5151
openSeaChest_Configure \fB\-d\fR /dev/sg<#> \fB\-\-setSCSIMP\fR file=modePageToChange.txt
5252
openSeaChest_Configure \fB\-d\fR /dev/sg<#> \fB\-\-provision\fR 134217728
53+
openSeaChest_Configure \fB\-d\fR /dev/sg<#> \fB\-\-setMaxLBA\fR 134217728 \fB\-\-changeIdString\fR
54+
openSeaChest_Configure \fB\-d\fR /dev/sg<#> \fB\-\-capacityModelNumberMapping\fR
5355
openSeaChest_Configure \fB\-d\fR /dev/sg<#> \fB\-\-dcoIdentify\fR
5456
openSeaChest_Configure \fB\-d\fR /dev/sg<#> \fB\-\-dcoRestore\fR
5557
openSeaChest_Configure \fB\-d\fR /dev/sg<#> \fB\-\-dcoFreezeLock\fR
@@ -254,6 +256,16 @@ is available.
254256
Use this option
255257
to issue a fast scan on the specified drive.
256258
.HP
259+
\fB\-\-capacityModelNumberMapping\fR
260+
.IP
261+
Use this option to display the capacity model number mapping
262+
TBD
263+
.HP
264+
\fB\-\-changeIdString\fR
265+
.IP
266+
Use this option to change ID string according to capacity \- model number
267+
mapping. Need to use together with \fB\-\-setMaxLBA\fR or \fB\-\-restoreMaxLBA\fR
268+
.HP
257269
\fB\-\-phySpeed\fR [0 | 1 | 2 | 3 | 4 | 5]
258270
.IP
259271
Use this option to change the PHY speed to a
@@ -792,21 +804,21 @@ using a TRIM/UNMAP command.
792804
openSeaChest_Configure \- openSeaChest drive utilities \- NVMe Enabled
793805
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
794806
openSeaChest_Configure Version: 2.7.1\-8_0_0 X86_64
795-
Build Date: May 31 2024
796-
Today: Tue Jul 30 20:33:33 2024 User: current user
807+
Build Date: Aug 26 2024
808+
Today: 20240828T143604 User: current user
797809
.PP
798810
==========================================================================================
799811
Version Info for openSeaChest_Configure:
800812
.IP
801813
Utility Version: 2.7.1
802-
opensea\-common Version: 3.0.0
814+
opensea\-common Version: 4.0.0
803815
opensea\-transport Version: 8.0.0
804-
opensea\-operations Version: 7.0.0
805-
Build Date: May 31 2024
816+
opensea\-operations Version: 8.0.0
817+
Build Date: Aug 26 2024
806818
Compiled Architecture: X86_64
807819
Detected Endianness: Little Endian
808820
Compiler Used: GCC
809-
Compiler Version: 11.2.1
821+
Compiler Version: 11.4.0
810822
Operating System Type: Linux
811823
Operating System Version: 5.15.153\-1
812824
Operating System Name: Ubuntu 22.04.4 LTS

‎docs/man/man8/openSeaChest_Defect.8‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
2-
.TH OPENSEACHEST_DEFECT "1" "May 2024" "openSeaChest_Defect ==========================================================================================" "User Commands"
2+
.TH OPENSEACHEST_DEFECT "1" "August 2024" "openSeaChest_Defect ==========================================================================================" "User Commands"
33
.SH NAME
44
openSeaChest_Defect \- manual page for openSeaChest_Defect ==========================================================================================
55
.SH DESCRIPTION
66
==========================================================================================
77
.IP
88
openSeaChest_Defect \- openSeaChest drive utilities \- NVMe Enabled
99
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
10-
openSeaChest_Defect Version: 0.9.0\-7_1_0 X86_64
11-
Build Date: May 6 2024
12-
Today: Mon May 6 12:10:34 2024 User: current user
10+
openSeaChest_Defect Version: 0.9.0\-8_0_0 X86_64
11+
Build Date: Aug 26 2024
12+
Today: 20240828T143604 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -371,24 +371,24 @@ starting LBA is specified.
371371
.IP
372372
openSeaChest_Defect \- openSeaChest drive utilities \- NVMe Enabled
373373
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
374-
openSeaChest_Defect Version: 0.9.0\-7_1_0 X86_64
375-
Build Date: May 6 2024
376-
Today: Mon May 6 12:10:34 2024 User: current user
374+
openSeaChest_Defect Version: 0.9.0\-8_0_0 X86_64
375+
Build Date: Aug 26 2024
376+
Today: 20240828T143604 User: current user
377377
.PP
378378
==========================================================================================
379379
Version Info for openSeaChest_Defect:
380380
.IP
381381
Utility Version: 0.9.0
382-
opensea\-common Version: 2.0.0
383-
opensea\-transport Version: 7.1.0
384-
opensea\-operations Version: 6.0.0
385-
Build Date: May 6 2024
382+
opensea\-common Version: 4.0.0
383+
opensea\-transport Version: 8.0.0
384+
opensea\-operations Version: 8.0.0
385+
Build Date: Aug 26 2024
386386
Compiled Architecture: X86_64
387387
Detected Endianness: Little Endian
388-
Compiler Used: Clang
389-
Compiler Version: 14.0.0
388+
Compiler Used: GCC
389+
Compiler Version: 11.4.0
390390
Operating System Type: Linux
391-
Operating System Version: 5.15.146\-0
391+
Operating System Version: 5.15.153\-1
392392
Operating System Name: Ubuntu 22.04.4 LTS
393393
.SH "SEE ALSO"
394394
The full documentation for

‎docs/man/man8/openSeaChest_Erase.8‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
2-
.TH OPENSEACHEST_ERASE "1" "July 2024" "openSeaChest_Erase ==========================================================================================" "User Commands"
2+
.TH OPENSEACHEST_ERASE "1" "August 2024" "openSeaChest_Erase ==========================================================================================" "User Commands"
33
.SH NAME
44
openSeaChest_Erase \- manual page for openSeaChest_Erase ==========================================================================================
55
.SH DESCRIPTION
@@ -8,8 +8,8 @@ openSeaChest_Erase \- manual page for openSeaChest_Erase =======================
88
openSeaChest_Erase \- openSeaChest drive utilities \- NVMe Enabled
99
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
1010
openSeaChest_Erase Version: 4.6.0\-8_0_0 X86_64
11-
Build Date: May 31 2024
12-
Today: Tue Jul 30 20:33:33 2024 User: current user
11+
Build Date: Aug 26 2024
12+
Today: 20240828T143604 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -851,21 +851,21 @@ for performance instead.
851851
openSeaChest_Erase \- openSeaChest drive utilities \- NVMe Enabled
852852
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
853853
openSeaChest_Erase Version: 4.6.0\-8_0_0 X86_64
854-
Build Date: May 31 2024
855-
Today: Tue Jul 30 20:33:33 2024 User: current user
854+
Build Date: Aug 26 2024
855+
Today: 20240828T143604 User: current user
856856
.PP
857857
==========================================================================================
858858
Version Info for openSeaChest_Erase:
859859
.IP
860860
Utility Version: 4.6.0
861-
opensea\-common Version: 3.0.0
861+
opensea\-common Version: 4.0.0
862862
opensea\-transport Version: 8.0.0
863-
opensea\-operations Version: 7.0.0
864-
Build Date: May 31 2024
863+
opensea\-operations Version: 8.0.0
864+
Build Date: Aug 26 2024
865865
Compiled Architecture: X86_64
866866
Detected Endianness: Little Endian
867867
Compiler Used: GCC
868-
Compiler Version: 11.2.1
868+
Compiler Version: 11.4.0
869869
Operating System Type: Linux
870870
Operating System Version: 5.15.153\-1
871871
Operating System Name: Ubuntu 22.04.4 LTS

‎docs/man/man8/openSeaChest_Firmware.8‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
2-
.TH OPENSEACHEST_FIRMWARE "1" "July 2024" "openSeaChest_Firmware ==========================================================================================" "User Commands"
2+
.TH OPENSEACHEST_FIRMWARE "1" "August 2024" "openSeaChest_Firmware ==========================================================================================" "User Commands"
33
.SH NAME
44
openSeaChest_Firmware \- manual page for openSeaChest_Firmware ==========================================================================================
55
.SH DESCRIPTION
66
==========================================================================================
77
.IP
88
openSeaChest_Firmware \- openSeaChest drive utilities \- NVMe Enabled
99
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
10-
openSeaChest_Firmware Version: 4.1.0\-8_0_0 X86_64
11-
Build Date: May 31 2024
12-
Today: Tue Jul 30 20:33:33 2024 User: current user
10+
openSeaChest_Firmware Version: 4.2.0\-8_0_0 X86_64
11+
Build Date: Aug 26 2024
12+
Today: 20240828T143605 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -354,22 +354,22 @@ with multiple logical units or namespaces.
354354
.IP
355355
openSeaChest_Firmware \- openSeaChest drive utilities \- NVMe Enabled
356356
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
357-
openSeaChest_Firmware Version: 4.1.0\-8_0_0 X86_64
358-
Build Date: May 31 2024
359-
Today: Tue Jul 30 20:33:33 2024 User: current user
357+
openSeaChest_Firmware Version: 4.2.0\-8_0_0 X86_64
358+
Build Date: Aug 26 2024
359+
Today: 20240828T143605 User: current user
360360
.PP
361361
==========================================================================================
362362
Version Info for openSeaChest_Firmware:
363363
.IP
364-
Utility Version: 4.1.0
365-
opensea\-common Version: 3.0.0
364+
Utility Version: 4.2.0
365+
opensea\-common Version: 4.0.0
366366
opensea\-transport Version: 8.0.0
367-
opensea\-operations Version: 7.0.0
368-
Build Date: May 31 2024
367+
opensea\-operations Version: 8.0.0
368+
Build Date: Aug 26 2024
369369
Compiled Architecture: X86_64
370370
Detected Endianness: Little Endian
371371
Compiler Used: GCC
372-
Compiler Version: 11.2.1
372+
Compiler Version: 11.4.0
373373
Operating System Type: Linux
374374
Operating System Version: 5.15.153\-1
375375
Operating System Name: Ubuntu 22.04.4 LTS

‎docs/man/man8/openSeaChest_Format.8‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
2-
.TH OPENSEACHEST_FORMAT "1" "July 2024" "openSeaChest_Format ==========================================================================================" "User Commands"
2+
.TH OPENSEACHEST_FORMAT "1" "August 2024" "openSeaChest_Format ==========================================================================================" "User Commands"
33
.SH NAME
44
openSeaChest_Format \- manual page for openSeaChest_Format ==========================================================================================
55
.SH DESCRIPTION
66
==========================================================================================
77
.IP
88
openSeaChest_Format \- openSeaChest drive utilities \- NVMe Enabled
99
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
10-
openSeaChest_Format Version: 3.1.0\-8_0_0 X86_64
11-
Build Date: May 31 2024
12-
Today: Tue Jul 30 20:33:33 2024 User: current user
10+
openSeaChest_Format Version: 3.2.0\-8_0_0 X86_64
11+
Build Date: Aug 26 2024
12+
Today: 20240828T143605 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -659,22 +659,22 @@ for performance instead.
659659
.IP
660660
openSeaChest_Format \- openSeaChest drive utilities \- NVMe Enabled
661661
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
662-
openSeaChest_Format Version: 3.1.0\-8_0_0 X86_64
663-
Build Date: May 31 2024
664-
Today: Tue Jul 30 20:33:33 2024 User: current user
662+
openSeaChest_Format Version: 3.2.0\-8_0_0 X86_64
663+
Build Date: Aug 26 2024
664+
Today: 20240828T143605 User: current user
665665
.PP
666666
==========================================================================================
667667
Version Info for openSeaChest_Format:
668668
.IP
669-
Utility Version: 3.1.0
670-
opensea\-common Version: 3.0.0
669+
Utility Version: 3.2.0
670+
opensea\-common Version: 4.0.0
671671
opensea\-transport Version: 8.0.0
672-
opensea\-operations Version: 7.0.0
673-
Build Date: May 31 2024
672+
opensea\-operations Version: 8.0.0
673+
Build Date: Aug 26 2024
674674
Compiled Architecture: X86_64
675675
Detected Endianness: Little Endian
676676
Compiler Used: GCC
677-
Compiler Version: 11.2.1
677+
Compiler Version: 11.4.0
678678
Operating System Type: Linux
679679
Operating System Version: 5.15.153\-1
680680
Operating System Name: Ubuntu 22.04.4 LTS

‎docs/man/man8/openSeaChest_GenericTests.8‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
2-
.TH OPENSEACHEST_GENERICTESTS "1" "July 2024" "openSeaChest_GenericTests ==========================================================================================" "User Commands"
2+
.TH OPENSEACHEST_GENERICTESTS "1" "August 2024" "openSeaChest_GenericTests ==========================================================================================" "User Commands"
33
.SH NAME
44
openSeaChest_GenericTests \- manual page for openSeaChest_GenericTests ==========================================================================================
55
.SH DESCRIPTION
@@ -8,8 +8,8 @@ openSeaChest_GenericTests \- manual page for openSeaChest_GenericTests =========
88
openSeaChest_GenericTests \- openSeaChest drive utilities \- NVMe Enabled
99
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
1010
openSeaChest_GenericTests Version: 2.3.0\-8_0_0 X86_64
11-
Build Date: May 31 2024
12-
Today: Tue Jul 30 20:33:34 2024 User: current user
11+
Build Date: Aug 26 2024
12+
Today: 20240828T143605 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -430,21 +430,21 @@ test as they are found.
430430
openSeaChest_GenericTests \- openSeaChest drive utilities \- NVMe Enabled
431431
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
432432
openSeaChest_GenericTests Version: 2.3.0\-8_0_0 X86_64
433-
Build Date: May 31 2024
434-
Today: Tue Jul 30 20:33:34 2024 User: current user
433+
Build Date: Aug 26 2024
434+
Today: 20240828T143605 User: current user
435435
.PP
436436
==========================================================================================
437437
Version Info for openSeaChest_GenericTests:
438438
.IP
439439
Utility Version: 2.3.0
440-
opensea\-common Version: 3.0.0
440+
opensea\-common Version: 4.0.0
441441
opensea\-transport Version: 8.0.0
442-
opensea\-operations Version: 7.0.0
443-
Build Date: May 31 2024
442+
opensea\-operations Version: 8.0.0
443+
Build Date: Aug 26 2024
444444
Compiled Architecture: X86_64
445445
Detected Endianness: Little Endian
446446
Compiler Used: GCC
447-
Compiler Version: 11.2.1
447+
Compiler Version: 11.4.0
448448
Operating System Type: Linux
449449
Operating System Version: 5.15.153\-1
450450
Operating System Name: Ubuntu 22.04.4 LTS

0 commit comments

Comments
 (0)