Skip to content

Commit a778e8a

Browse files
yorevsyorevs
authored
Merge pull request HS-Teams#55 from HS-Teams/codex/fix-syntax-in-man-pages-yal0jg
Normalize man page syntax
2 parents ddd896e + 59e442b commit a778e8a

File tree

88 files changed

+1936
-3080
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+1936
-3080
lines changed

‎docs/man/man.1/__hhs_about.1‎

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,22 @@
1-
#!/bin/ksh
2-
#================================================================
3-
# HEADER
4-
#================================================================
5-
#% SYNOPSIS
6-
#+ __hhs_about [options]
7-
#%
8-
#% DESCRIPTION
9-
#% Display information about the given command.
10-
#%
11-
#% OPTIONS
12-
#% Use "__hhs_about -h" or "__hhs_about --help" for full usage details.
13-
#%
14-
#% EXAMPLES
15-
#% __hhs_about --help
16-
#%
17-
#================================================================
18-
#- IMPLEMENTATION
19-
#- version __hhs_about (HomeSetup) 1.0.0
20-
#- author HomeSetup Team
21-
#- license MIT <https://opensource.org/licenses/MIT>
22-
#- script_id autogenerated
23-
#-
24-
#================================================================
25-
# HISTORY
26-
# 2025/11/20 : homesetup-docs : Generated from templates/txt/man.txt
27-
#
28-
#================================================================
29-
# DEBUG OPTION
30-
# set -n # Uncomment to check your syntax, without execution.
31-
# set -x # Uncomment to debug this shell script.
32-
#
33-
#================================================================
34-
# END_OF_HEADER
35-
#================================================================
1+
." Auto-generated man page. Do not edit manually.
2+
.TH "__hhs_about" "1" "2025-11-20" "HomeSetup" "User Commands"
3+
.SH NAME
4+
__hhs_about \-
5+
Display information about the given command.
6+
.SH SYNOPSIS
7+
.nf
8+
__hhs_about [options]
9+
.fi
10+
.SH DESCRIPTION
11+
Display information about the given command.
12+
.SH OPTIONS
13+
Use "__hhs_about -h" or "__hhs_about --help" for full usage details.
14+
.SH EXAMPLES
15+
.TP
16+
__hhs_about --help
17+
.SH VERSION
18+
__hhs_about (HomeSetup) 1.0.0
19+
.SH AUTHOR
20+
HomeSetup Team
21+
.SH LICENSE
22+
MIT <https://opensource.org/licenses/MIT>

‎docs/man/man.1/__hhs_activate_docker.1‎

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,22 @@
1-
#!/bin/ksh
2-
#================================================================
3-
# HEADER
4-
#================================================================
5-
#% SYNOPSIS
6-
#+ __hhs_activate_docker [options]
7-
#%
8-
#% DESCRIPTION
9-
#% Lazy load helper function to initialize Docker-Daemon for the terminal.
10-
#%
11-
#% OPTIONS
12-
#% Use "__hhs_activate_docker -h" or "__hhs_activate_docker --help" for full usage details.
13-
#%
14-
#% EXAMPLES
15-
#% __hhs_activate_docker --help
16-
#%
17-
#================================================================
18-
#- IMPLEMENTATION
19-
#- version __hhs_activate_docker (HomeSetup) 1.0.0
20-
#- author HomeSetup Team
21-
#- license MIT <https://opensource.org/licenses/MIT>
22-
#- script_id autogenerated
23-
#-
24-
#================================================================
25-
# HISTORY
26-
# 2025/11/20 : homesetup-docs : Generated from templates/txt/man.txt
27-
#
28-
#================================================================
29-
# DEBUG OPTION
30-
# set -n # Uncomment to check your syntax, without execution.
31-
# set -x # Uncomment to debug this shell script.
32-
#
33-
#================================================================
34-
# END_OF_HEADER
35-
#================================================================
1+
." Auto-generated man page. Do not edit manually.
2+
.TH "__hhs_activate_docker" "1" "2025-11-20" "HomeSetup" "User Commands"
3+
.SH NAME
4+
__hhs_activate_docker \-
5+
Lazy load helper function to initialize Docker-Daemon for the terminal.
6+
.SH SYNOPSIS
7+
.nf
8+
__hhs_activate_docker [options]
9+
.fi
10+
.SH DESCRIPTION
11+
Lazy load helper function to initialize Docker-Daemon for the terminal.
12+
.SH OPTIONS
13+
Use "__hhs_activate_docker -h" or "__hhs_activate_docker --help" for full usage details.
14+
.SH EXAMPLES
15+
.TP
16+
__hhs_activate_docker --help
17+
.SH VERSION
18+
__hhs_activate_docker (HomeSetup) 1.0.0
19+
.SH AUTHOR
20+
HomeSetup Team
21+
.SH LICENSE
22+
MIT <https://opensource.org/licenses/MIT>

‎docs/man/man.1/__hhs_activate_jenv.1‎

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,22 @@
1-
#!/bin/ksh
2-
#================================================================
3-
# HEADER
4-
#================================================================
5-
#% SYNOPSIS
6-
#+ __hhs_activate_jenv [options]
7-
#%
8-
#% DESCRIPTION
9-
#% Lazy load helper function to initialize Jenv for the terminal.
10-
#%
11-
#% OPTIONS
12-
#% Use "__hhs_activate_jenv -h" or "__hhs_activate_jenv --help" for full usage details.
13-
#%
14-
#% EXAMPLES
15-
#% __hhs_activate_jenv --help
16-
#%
17-
#================================================================
18-
#- IMPLEMENTATION
19-
#- version __hhs_activate_jenv (HomeSetup) 1.0.0
20-
#- author HomeSetup Team
21-
#- license MIT <https://opensource.org/licenses/MIT>
22-
#- script_id autogenerated
23-
#-
24-
#================================================================
25-
# HISTORY
26-
# 2025/11/20 : homesetup-docs : Generated from templates/txt/man.txt
27-
#
28-
#================================================================
29-
# DEBUG OPTION
30-
# set -n # Uncomment to check your syntax, without execution.
31-
# set -x # Uncomment to debug this shell script.
32-
#
33-
#================================================================
34-
# END_OF_HEADER
35-
#================================================================
1+
." Auto-generated man page. Do not edit manually.
2+
.TH "__hhs_activate_jenv" "1" "2025-11-20" "HomeSetup" "User Commands"
3+
.SH NAME
4+
__hhs_activate_jenv \-
5+
Lazy load helper function to initialize Jenv for the terminal.
6+
.SH SYNOPSIS
7+
.nf
8+
__hhs_activate_jenv [options]
9+
.fi
10+
.SH DESCRIPTION
11+
Lazy load helper function to initialize Jenv for the terminal.
12+
.SH OPTIONS
13+
Use "__hhs_activate_jenv -h" or "__hhs_activate_jenv --help" for full usage details.
14+
.SH EXAMPLES
15+
.TP
16+
__hhs_activate_jenv --help
17+
.SH VERSION
18+
__hhs_activate_jenv (HomeSetup) 1.0.0
19+
.SH AUTHOR
20+
HomeSetup Team
21+
.SH LICENSE
22+
MIT <https://opensource.org/licenses/MIT>

‎docs/man/man.1/__hhs_activate_nvm.1‎

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,22 @@
1-
#!/bin/ksh
2-
#================================================================
3-
# HEADER
4-
#================================================================
5-
#% SYNOPSIS
6-
#+ __hhs_activate_nvm [options]
7-
#%
8-
#% DESCRIPTION
9-
#% Lazy load helper function to initialize NVM for the terminal.
10-
#%
11-
#% OPTIONS
12-
#% Use "__hhs_activate_nvm -h" or "__hhs_activate_nvm --help" for full usage details.
13-
#%
14-
#% EXAMPLES
15-
#% __hhs_activate_nvm --help
16-
#%
17-
#================================================================
18-
#- IMPLEMENTATION
19-
#- version __hhs_activate_nvm (HomeSetup) 1.0.0
20-
#- author HomeSetup Team
21-
#- license MIT <https://opensource.org/licenses/MIT>
22-
#- script_id autogenerated
23-
#-
24-
#================================================================
25-
# HISTORY
26-
# 2025/11/20 : homesetup-docs : Generated from templates/txt/man.txt
27-
#
28-
#================================================================
29-
# DEBUG OPTION
30-
# set -n # Uncomment to check your syntax, without execution.
31-
# set -x # Uncomment to debug this shell script.
32-
#
33-
#================================================================
34-
# END_OF_HEADER
35-
#================================================================
1+
." Auto-generated man page. Do not edit manually.
2+
.TH "__hhs_activate_nvm" "1" "2025-11-20" "HomeSetup" "User Commands"
3+
.SH NAME
4+
__hhs_activate_nvm \-
5+
Lazy load helper function to initialize NVM for the terminal.
6+
.SH SYNOPSIS
7+
.nf
8+
__hhs_activate_nvm [options]
9+
.fi
10+
.SH DESCRIPTION
11+
Lazy load helper function to initialize NVM for the terminal.
12+
.SH OPTIONS
13+
Use "__hhs_activate_nvm -h" or "__hhs_activate_nvm --help" for full usage details.
14+
.SH EXAMPLES
15+
.TP
16+
__hhs_activate_nvm --help
17+
.SH VERSION
18+
__hhs_activate_nvm (HomeSetup) 1.0.0
19+
.SH AUTHOR
20+
HomeSetup Team
21+
.SH LICENSE
22+
MIT <https://opensource.org/licenses/MIT>

‎docs/man/man.1/__hhs_activate_rvm.1‎

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,22 @@
1-
#!/bin/ksh
2-
#================================================================
3-
# HEADER
4-
#================================================================
5-
#% SYNOPSIS
6-
#+ __hhs_activate_rvm [options]
7-
#%
8-
#% DESCRIPTION
9-
#% Lazy load helper function to initialize RVM for the terminal.
10-
#%
11-
#% OPTIONS
12-
#% Use "__hhs_activate_rvm -h" or "__hhs_activate_rvm --help" for full usage details.
13-
#%
14-
#% EXAMPLES
15-
#% __hhs_activate_rvm --help
16-
#%
17-
#================================================================
18-
#- IMPLEMENTATION
19-
#- version __hhs_activate_rvm (HomeSetup) 1.0.0
20-
#- author HomeSetup Team
21-
#- license MIT <https://opensource.org/licenses/MIT>
22-
#- script_id autogenerated
23-
#-
24-
#================================================================
25-
# HISTORY
26-
# 2025/11/20 : homesetup-docs : Generated from templates/txt/man.txt
27-
#
28-
#================================================================
29-
# DEBUG OPTION
30-
# set -n # Uncomment to check your syntax, without execution.
31-
# set -x # Uncomment to debug this shell script.
32-
#
33-
#================================================================
34-
# END_OF_HEADER
35-
#================================================================
1+
." Auto-generated man page. Do not edit manually.
2+
.TH "__hhs_activate_rvm" "1" "2025-11-20" "HomeSetup" "User Commands"
3+
.SH NAME
4+
__hhs_activate_rvm \-
5+
Lazy load helper function to initialize RVM for the terminal.
6+
.SH SYNOPSIS
7+
.nf
8+
__hhs_activate_rvm [options]
9+
.fi
10+
.SH DESCRIPTION
11+
Lazy load helper function to initialize RVM for the terminal.
12+
.SH OPTIONS
13+
Use "__hhs_activate_rvm -h" or "__hhs_activate_rvm --help" for full usage details.
14+
.SH EXAMPLES
15+
.TP
16+
__hhs_activate_rvm --help
17+
.SH VERSION
18+
__hhs_activate_rvm (HomeSetup) 1.0.0
19+
.SH AUTHOR
20+
HomeSetup Team
21+
.SH LICENSE
22+
MIT <https://opensource.org/licenses/MIT>

‎docs/man/man.1/__hhs_active_ifaces.1‎

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,22 @@
1-
#!/bin/ksh
2-
#================================================================
3-
# HEADER
4-
#================================================================
5-
#% SYNOPSIS
6-
#+ __hhs_active_ifaces [options]
7-
#%
8-
#% DESCRIPTION
9-
#% Display a list of active network interfaces.
10-
#%
11-
#% OPTIONS
12-
#% Use "__hhs_active_ifaces -h" or "__hhs_active_ifaces --help" for full usage details.
13-
#%
14-
#% EXAMPLES
15-
#% __hhs_active_ifaces --help
16-
#%
17-
#================================================================
18-
#- IMPLEMENTATION
19-
#- version __hhs_active_ifaces (HomeSetup) 1.0.0
20-
#- author HomeSetup Team
21-
#- license MIT <https://opensource.org/licenses/MIT>
22-
#- script_id autogenerated
23-
#-
24-
#================================================================
25-
# HISTORY
26-
# 2025/11/20 : homesetup-docs : Generated from templates/txt/man.txt
27-
#
28-
#================================================================
29-
# DEBUG OPTION
30-
# set -n # Uncomment to check your syntax, without execution.
31-
# set -x # Uncomment to debug this shell script.
32-
#
33-
#================================================================
34-
# END_OF_HEADER
35-
#================================================================
1+
." Auto-generated man page. Do not edit manually.
2+
.TH "__hhs_active_ifaces" "1" "2025-11-20" "HomeSetup" "User Commands"
3+
.SH NAME
4+
__hhs_active_ifaces \-
5+
Display a list of active network interfaces.
6+
.SH SYNOPSIS
7+
.nf
8+
__hhs_active_ifaces [options]
9+
.fi
10+
.SH DESCRIPTION
11+
Display a list of active network interfaces.
12+
.SH OPTIONS
13+
Use "__hhs_active_ifaces -h" or "__hhs_active_ifaces --help" for full usage details.
14+
.SH EXAMPLES
15+
.TP
16+
__hhs_active_ifaces --help
17+
.SH VERSION
18+
__hhs_active_ifaces (HomeSetup) 1.0.0
19+
.SH AUTHOR
20+
HomeSetup Team
21+
.SH LICENSE
22+
MIT <https://opensource.org/licenses/MIT>

0 commit comments

Comments
 (0)