Skip to content

Commit 93cef7e

Browse files
vonericsenvonericsen
committed
doc: Updating checked in docs man pages when help2man is not available
Signed-off-by: Tyler Erickson <tyler.erickson@seagate.com>
1 parent 9ce4cf8 commit 93cef7e

17 files changed

+391
-105
lines changed

‎docs/man/man8/openSeaChest_Basics.8

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ openSeaChest_Basics \- manual page for openSeaChest_Basics =====================
88
openSeaChest_Basics \- openSeaChest drive utilities \- NVMe Enabled
99
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
1010
openSeaChest_Basics Version: 3.6.2\-8_0_1 X86_64
11-
Build Date: Aug 28 2024
12-
Today: 20240911T100228 User: current user
11+
Build Date: Sep 19 2024
12+
Today: 20240925T133704 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -73,6 +73,18 @@ Anything else = unknown error
7373
Utility Options
7474
===============
7575
.HP
76+
\fB\-\-csmiIgnorePort\fR (Obsolete)
77+
.IP
78+
This option is obsolete and will be removed in future versions.
79+
.HP
80+
\fB\-\-csmiUsePort\fR (Obsolete)
81+
.IP
82+
This option is obsolete and will be removed in future versions.
83+
.HP
84+
\fB\-\-csmiVerbose\fR (Obsolete)
85+
.IP
86+
This option is obsolete and will be removed in future versions.
87+
.HP
7688
\fB\-\-echoCommandLine\fR
7789
.IP
7890
Echo the command line entered into the utility on the screen.
@@ -226,6 +238,10 @@ interfaceSCSI \- show devices on a SCSI or SAS interface
226238
interfaceNVME = show devices on an NVMe interface
227239
sd \- show sd device handles
228240
sgtosd \- show the sd and sg device handle mapping
241+
ignoreCSMI \- do not scan for any CSMI devices
242+
allowDuplicates \- allow drives with both CSMI and PD handles
243+
.IP
244+
to show up multiple times in the list
229245
.HP
230246
\fB\-S\fR, \fB\-\-Scan\fR
231247
.IP
@@ -243,6 +259,7 @@ devices in the system when the device is unable to come to a ready state.
243259
.IP
244260
Use this option with most commands to specify the device
245261
handle on which to perform an operation. Example: /dev/sg<#>
262+
CSMI device handles can be specified as <error<#><#><#>>
246263
To run across all devices detected in the system, use the
247264
"all" argument instead of a device handle.
248265
Example: \fB\-d\fR all
@@ -575,17 +592,17 @@ with the \fB\-\-trim\fR/\-\-unmapRange option.
575592
openSeaChest_Basics \- openSeaChest drive utilities \- NVMe Enabled
576593
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
577594
openSeaChest_Basics Version: 3.6.2\-8_0_1 X86_64
578-
Build Date: Aug 28 2024
579-
Today: 20240911T100228 User: current user
595+
Build Date: Sep 19 2024
596+
Today: 20240925T133705 User: current user
580597
.PP
581598
==========================================================================================
582599
Version Info for openSeaChest_Basics:
583600
.IP
584601
Utility Version: 3.6.2
585602
opensea\-common Version: 4.1.0
586603
opensea\-transport Version: 8.0.1
587-
opensea\-operations Version: 8.0.1
588-
Build Date: Aug 28 2024
604+
opensea\-operations Version: 8.0.2
605+
Build Date: Sep 19 2024
589606
Compiled Architecture: X86_64
590607
Detected Endianness: Little Endian
591608
Compiler Used: GCC

‎docs/man/man8/openSeaChest_Configure.8

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -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_1 X86_64
11-
Build Date: Aug 28 2024
12-
Today: 20240911T100228 User: current user
11+
Build Date: Sep 19 2024
12+
Today: 20240925T133705 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -76,6 +76,18 @@ Anything else = unknown error
7676
Utility Options
7777
===============
7878
.HP
79+
\fB\-\-csmiIgnorePort\fR (Obsolete)
80+
.IP
81+
This option is obsolete and will be removed in future versions.
82+
.HP
83+
\fB\-\-csmiUsePort\fR (Obsolete)
84+
.IP
85+
This option is obsolete and will be removed in future versions.
86+
.HP
87+
\fB\-\-csmiVerbose\fR (Obsolete)
88+
.IP
89+
This option is obsolete and will be removed in future versions.
90+
.HP
7991
\fB\-\-echoCommandLine\fR
8092
.IP
8193
Echo the command line entered into the utility on the screen.
@@ -183,6 +195,7 @@ Utility Arguments
183195
.IP
184196
Use this option with most commands to specify the device
185197
handle on which to perform an operation. Example: /dev/sg<#>
198+
CSMI device handles can be specified as <error<#><#><#>>
186199
To run across all devices detected in the system, use the
187200
"all" argument instead of a device handle.
188201
Example: \fB\-d\fR all
@@ -208,6 +221,10 @@ interfaceSCSI \- show devices on a SCSI or SAS interface
208221
interfaceNVME = show devices on an NVMe interface
209222
sd \- show sd device handles
210223
sgtosd \- show the sd and sg device handle mapping
224+
ignoreCSMI \- do not scan for any CSMI devices
225+
allowDuplicates \- allow drives with both CSMI and PD handles
226+
.IP
227+
to show up multiple times in the list
211228
.HP
212229
\fB\-i\fR, \fB\-\-deviceInfo\fR
213230
.IP
@@ -804,17 +821,17 @@ using a TRIM/UNMAP command.
804821
openSeaChest_Configure \- openSeaChest drive utilities \- NVMe Enabled
805822
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
806823
openSeaChest_Configure Version: 2.7.1\-8_0_1 X86_64
807-
Build Date: Aug 28 2024
808-
Today: 20240911T100228 User: current user
824+
Build Date: Sep 19 2024
825+
Today: 20240925T133705 User: current user
809826
.PP
810827
==========================================================================================
811828
Version Info for openSeaChest_Configure:
812829
.IP
813830
Utility Version: 2.7.1
814831
opensea\-common Version: 4.1.0
815832
opensea\-transport Version: 8.0.1
816-
opensea\-operations Version: 8.0.1
817-
Build Date: Aug 28 2024
833+
opensea\-operations Version: 8.0.2
834+
Build Date: Sep 19 2024
818835
Compiled Architecture: X86_64
819836
Detected Endianness: Little Endian
820837
Compiler Used: GCC

‎docs/man/man8/openSeaChest_Defect.8

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ openSeaChest_Defect \- manual page for openSeaChest_Defect =====================
88
openSeaChest_Defect \- openSeaChest drive utilities \- NVMe Enabled
99
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
1010
openSeaChest_Defect Version: 0.9.0\-8_0_1 X86_64
11-
Build Date: Aug 28 2024
12-
Today: 20240911T100228 User: current user
11+
Build Date: Sep 19 2024
12+
Today: 20240925T133705 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -42,6 +42,18 @@ Anything else = unknown error
4242
Utility Options
4343
===============
4444
.HP
45+
\fB\-\-csmiIgnorePort\fR (Obsolete)
46+
.IP
47+
This option is obsolete and will be removed in future versions.
48+
.HP
49+
\fB\-\-csmiUsePort\fR (Obsolete)
50+
.IP
51+
This option is obsolete and will be removed in future versions.
52+
.HP
53+
\fB\-\-csmiVerbose\fR (Obsolete)
54+
.IP
55+
This option is obsolete and will be removed in future versions.
56+
.HP
4557
\fB\-\-echoCommandLine\fR
4658
.IP
4759
Echo the command line entered into the utility on the screen.
@@ -149,6 +161,7 @@ Utility Arguments
149161
.IP
150162
Use this option with most commands to specify the device
151163
handle on which to perform an operation. Example: /dev/sg<#>
164+
CSMI device handles can be specified as <error<#><#><#>>
152165
To run across all devices detected in the system, use the
153166
"all" argument instead of a device handle.
154167
Example: \fB\-d\fR all
@@ -174,6 +187,10 @@ interfaceSCSI \- show devices on a SCSI or SAS interface
174187
interfaceNVME = show devices on an NVMe interface
175188
sd \- show sd device handles
176189
sgtosd \- show the sd and sg device handle mapping
190+
ignoreCSMI \- do not scan for any CSMI devices
191+
allowDuplicates \- allow drives with both CSMI and PD handles
192+
.IP
193+
to show up multiple times in the list
177194
.HP
178195
\fB\-i\fR, \fB\-\-deviceInfo\fR
179196
.IP
@@ -372,17 +389,17 @@ starting LBA is specified.
372389
openSeaChest_Defect \- openSeaChest drive utilities \- NVMe Enabled
373390
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
374391
openSeaChest_Defect Version: 0.9.0\-8_0_1 X86_64
375-
Build Date: Aug 28 2024
376-
Today: 20240911T100228 User: current user
392+
Build Date: Sep 19 2024
393+
Today: 20240925T133705 User: current user
377394
.PP
378395
==========================================================================================
379396
Version Info for openSeaChest_Defect:
380397
.IP
381398
Utility Version: 0.9.0
382399
opensea\-common Version: 4.1.0
383400
opensea\-transport Version: 8.0.1
384-
opensea\-operations Version: 8.0.1
385-
Build Date: Aug 28 2024
401+
opensea\-operations Version: 8.0.2
402+
Build Date: Sep 19 2024
386403
Compiled Architecture: X86_64
387404
Detected Endianness: Little Endian
388405
Compiler Used: GCC

‎docs/man/man8/openSeaChest_Erase.8

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -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_1 X86_64
11-
Build Date: Aug 28 2024
12-
Today: 20240911T100229 User: current user
11+
Build Date: Sep 19 2024
12+
Today: 20240925T133705 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -69,6 +69,18 @@ Anything else = unknown error
6969
Utility Options
7070
===============
7171
.HP
72+
\fB\-\-csmiIgnorePort\fR (Obsolete)
73+
.IP
74+
This option is obsolete and will be removed in future versions.
75+
.HP
76+
\fB\-\-csmiUsePort\fR (Obsolete)
77+
.IP
78+
This option is obsolete and will be removed in future versions.
79+
.HP
80+
\fB\-\-csmiVerbose\fR (Obsolete)
81+
.IP
82+
This option is obsolete and will be removed in future versions.
83+
.HP
7284
\fB\-\-echoCommandLine\fR
7385
.IP
7486
Echo the command line entered into the utility on the screen.
@@ -182,6 +194,7 @@ Utility Arguments
182194
.IP
183195
Use this option with most commands to specify the device
184196
handle on which to perform an operation. Example: /dev/sg<#>
197+
CSMI device handles can be specified as <error<#><#><#>>
185198
To run across all devices detected in the system, use the
186199
"all" argument instead of a device handle.
187200
Example: \fB\-d\fR all
@@ -214,6 +227,10 @@ interfaceSCSI \- show devices on a SCSI or SAS interface
214227
interfaceNVME = show devices on an NVMe interface
215228
sd \- show sd device handles
216229
sgtosd \- show the sd and sg device handle mapping
230+
ignoreCSMI \- do not scan for any CSMI devices
231+
allowDuplicates \- allow drives with both CSMI and PD handles
232+
.IP
233+
to show up multiple times in the list
217234
.HP
218235
\fB\-i\fR, \fB\-\-deviceInfo\fR
219236
.IP
@@ -851,17 +868,17 @@ for performance instead.
851868
openSeaChest_Erase \- openSeaChest drive utilities \- NVMe Enabled
852869
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
853870
openSeaChest_Erase Version: 4.6.0\-8_0_1 X86_64
854-
Build Date: Aug 28 2024
855-
Today: 20240911T100229 User: current user
871+
Build Date: Sep 19 2024
872+
Today: 20240925T133705 User: current user
856873
.PP
857874
==========================================================================================
858875
Version Info for openSeaChest_Erase:
859876
.IP
860877
Utility Version: 4.6.0
861878
opensea\-common Version: 4.1.0
862879
opensea\-transport Version: 8.0.1
863-
opensea\-operations Version: 8.0.1
864-
Build Date: Aug 28 2024
880+
opensea\-operations Version: 8.0.2
881+
Build Date: Sep 19 2024
865882
Compiled Architecture: X86_64
866883
Detected Endianness: Little Endian
867884
Compiler Used: GCC

‎docs/man/man8/openSeaChest_Firmware.8

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ openSeaChest_Firmware \- manual page for openSeaChest_Firmware =================
88
openSeaChest_Firmware \- openSeaChest drive utilities \- NVMe Enabled
99
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
1010
openSeaChest_Firmware Version: 4.2.0\-8_0_1 X86_64
11-
Build Date: Aug 28 2024
12-
Today: 20240911T100229 User: current user
11+
Build Date: Sep 19 2024
12+
Today: 20240925T133705 User: current user
1313
.PP
1414
==========================================================================================
1515
Usage
@@ -65,6 +65,18 @@ Anything else = unknown error
6565
Utility Options
6666
===============
6767
.HP
68+
\fB\-\-csmiIgnorePort\fR (Obsolete)
69+
.IP
70+
This option is obsolete and will be removed in future versions.
71+
.HP
72+
\fB\-\-csmiUsePort\fR (Obsolete)
73+
.IP
74+
This option is obsolete and will be removed in future versions.
75+
.HP
76+
\fB\-\-csmiVerbose\fR (Obsolete)
77+
.IP
78+
This option is obsolete and will be removed in future versions.
79+
.HP
6880
\fB\-\-echoCommandLine\fR
6981
.IP
7082
Echo the command line entered into the utility on the screen.
@@ -179,6 +191,7 @@ Utility Arguments
179191
.IP
180192
Use this option with most commands to specify the device
181193
handle on which to perform an operation. Example: /dev/sg<#>
194+
CSMI device handles can be specified as <error<#><#><#>>
182195
To run across all devices detected in the system, use the
183196
"all" argument instead of a device handle.
184197
Example: \fB\-d\fR all
@@ -204,6 +217,10 @@ interfaceSCSI \- show devices on a SCSI or SAS interface
204217
interfaceNVME = show devices on an NVMe interface
205218
sd \- show sd device handles
206219
sgtosd \- show the sd and sg device handle mapping
220+
ignoreCSMI \- do not scan for any CSMI devices
221+
allowDuplicates \- allow drives with both CSMI and PD handles
222+
.IP
223+
to show up multiple times in the list
207224
.HP
208225
\fB\-i\fR, \fB\-\-deviceInfo\fR
209226
.IP
@@ -355,17 +372,17 @@ with multiple logical units or namespaces.
355372
openSeaChest_Firmware \- openSeaChest drive utilities \- NVMe Enabled
356373
Copyright (c) 2014\-2024 Seagate Technology LLC and/or its Affiliates, All Rights Reserved
357374
openSeaChest_Firmware Version: 4.2.0\-8_0_1 X86_64
358-
Build Date: Aug 28 2024
359-
Today: 20240911T100229 User: current user
375+
Build Date: Sep 19 2024
376+
Today: 20240925T133705 User: current user
360377
.PP
361378
==========================================================================================
362379
Version Info for openSeaChest_Firmware:
363380
.IP
364381
Utility Version: 4.2.0
365382
opensea\-common Version: 4.1.0
366383
opensea\-transport Version: 8.0.1
367-
opensea\-operations Version: 8.0.1
368-
Build Date: Aug 28 2024
384+
opensea\-operations Version: 8.0.2
385+
Build Date: Sep 19 2024
369386
Compiled Architecture: X86_64
370387
Detected Endianness: Little Endian
371388
Compiler Used: GCC

0 commit comments

Comments
 (0)