Documentation
Rate This Document
Findability
Accuracy
Completeness
Readability
SubmitClose

man

Command Function

Displays the function description and examples of the use subcommand.

Syntax

1
man [-h] [--lang <language>]

Parameter Description

Table 1 man subcommand parameters

Parameter

Description

None

Displays the use subcommand manual directory.

-h/--help

Obtains help information. This parameter is optional.

--lang

Sets the tool manual language, which defaults to Chinese.

  • zh: Chinese
  • en: English
NOTE:

If the environment does not support Chinese, the system automatically switches to English.

Example

Type man and press Enter to view the directory of the use subcommand manual.
1
man --lang en

Command output:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
================================================================================
=================================== Manual directory ===================================
================================================================================
1 show                  -  Displays tuning data and analyzes parameter importance.
2 train                 -  Resumes automatic tuning. The Kunpeng AutoTuner automatically tunes task parameters based on service scenario metrics.
3 test                  -  Performs the specified test rounds again with their parameters.
4 set                   -  Applies the parameter values of a round of to the system.
5 suggestions           -  Displays recommended parameters.
a all                   -  Display all sections.
q quit                  -  Exits the menu.
                                         
================================================================================

Enter choice:

Type 4 and press Enter to view the help information about the set subcommand.

Command output:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Deliver the parameters of the selected nth round to the configuration file or a temporary file. The parameters will be used for training or directly used to run the application during subsequent tuning.

Name
    set -           Set the configuration of the <n>th round.
Usage
    set <n>         Set the parameters of the <n>th round.
Description
    set <n>:        Deliver the parameters of the nth round in the train folder to the configuration file or the temporary file. The parameters will be read for training in subsequent tuning.

Example
    set 6: Deliver the parameters of the sixth round to the configuration file.
    ======================== info of Round   6   ===================================
    Performance: 38219.08
    --------------------------------------------------------------------------------
    ----------------------          Params         ---------------------------------
    --------------------------------------------------------------------------------
    PostgreSQL:
         autovacuum_vacuum_cost_delay                = 99
         autovacuum_vacuum_cost_limit                = 317
                                    ...
                                    ...
                                    ...
         vacuum_cleanup_index_scale_factor           = 0.25364252425682277
    --------------------------------------------------------------------------------
    ---------------------          Run Info        ---------------------------------
    --------------------------------------------------------------------------------
    Run record: 1
    Result: success
    Performance: 86.92
    Run time: 2025-02-25 09:38:59.669973
    Finish time: 2025-02-25 09:38:59.669980
    ================================================================================
    --------- kunpeng automatic tuning - Step   <assign params>    start -----------
    set params of  success!


(Press q to return)