feat: add all options

Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>

tools/imctl/cmd/genman/README.md

@@ -0,0 +1,49 @@
+# OpenIM `man` Module README
+
+Welcome to the `man` module of OpenIM, the comprehensive guide for using OpenIM's range of powerful commands. Here, you'll find in-depth details for each command, its options, and examples to help you harness the full power of the OpenIM suite.
+
+## Overview
+
+OpenIM is a robust instant messaging solution. To ensure users can effectively harness its capabilities, OpenIM provides a suite of commands that serve different functionalities, from the API level to RPC calls and utilities.
+
+The `man` module ensures that users, both new and experienced, have a reliable source of information and documentation to use these commands effectively.
+
+## Available Commands
+
+The OpenIM commands are divided into core services and tools. Below is a brief overview of each:
+
+### Core Services
+
+- **openim-api**: Interface to the main functionalities of OpenIM.
+- **openim-cmdutils**: Utilities for executing common tasks.
+- **openim-crontask**: Schedule and manage routine tasks within OpenIM.
+- **openim-msggateway**: Gateway for managing messages within the OpenIM system.
+- **openim-msgtransfer**: Handle message transfers across different parts of OpenIM.
+- **openim-push**: Service for pushing notifications and updates.
+- **openim-rpc-auth**: RPC interface for authentication tasks.
+- **openim-rpc-conversation**: RPC service for handling conversations.
+- **openim-rpc-friend**: Manage friend lists and related functionalities through RPC.
+- **openim-rpc-group**: Group management via RPC.
+- **openim-rpc-msg**: Message handling at the RPC level.
+- **openim-rpc-third**: Third-party integrations and related tasks through RPC.
+- **openim-rpc-user**: User management and tasks via RPC.
+
+### Tools
+
+- **changelog**: Track and manage changes in OpenIM.
+- **component**: Utilities related to different components within OpenIM.
+- **infra**: Infrastructure and backend management tools.
+- **ncpu**: Monitor and manage CPU usage and related tasks.
+- **yamlfmt**: A tool for formatting and linting YAML files within the OpenIM configuration.
+
+## How to Use
+
+To view the manual page for any of the OpenIM commands, use the `man` command followed by the command name. For example:
+
+```
+man openim-api
+```
+
+## Contributions
+
+We welcome contributions to enhance the `man` pages. If you discover inconsistencies, errors, or areas where further details are required, feel free to raise an issue or submit a pull request.

tools/imctl/cmd/genman/genman.go

@@ -0,0 +1,31 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"k8s.io/kubernetes/cmd/genutils"
+)
+
+func main() {
+	// use os.Args instead of "flags" because "flags" will mess up the man pages!
+	path := "docs/man/man1"
+	module := ""
+	if len(os.Args) == 3 {
+		path = os.Args[1]
+		module = os.Args[2]
+	} else {
+		fmt.Fprintf(os.Stderr, "usage: %s [output directory] [module] \n", os.Args[0])
+		os.Exit(1)
+	}
+
+	outDir, err := genutils.OutDir(path)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "failed to get output directory: %v\n", err)
+		os.Exit(1)
+	}
+
+	// Set environment variables used by command so the output is consistent,
+	// regardless of where we run.
+	os.Setenv("HOME", "/home/username")
+}

tools/imctl/internal/imctl/util/term/resize.go

@@ -1,7 +1,3 @@
-// Copyright 2020 Lingfei Kong <colin404@foxmail.com>. All rights reserved.
-// Use of this source code is governed by a MIT style
-// license that can be found in the LICENSE file.
-
 package term
 
 import (

tools/imctl/internal/imctl/util/term/term.go

@@ -1,7 +1,3 @@
-// Copyright 2020 Lingfei Kong <colin404@foxmail.com>. All rights reserved.
-// Use of this source code is governed by a MIT style
-// license that can be found in the LICENSE file.
-
 // Package term provides structures and helper functions to work with
 // terminal (state, sizes).
 package term

tools/imctl/internal/imctl/util/term/term_writer.go

@@ -1,7 +1,3 @@
-// Copyright 2020 Lingfei Kong <colin404@foxmail.com>. All rights reserved.
-// Use of this source code is governed by a MIT style
-// license that can be found in the LICENSE file.
-
 package term
 
 import (
@@ -20,9 +16,11 @@ type wordWrapWriter struct {
 // NewResponsiveWriter creates a Writer that detects the column width of the
 // terminal we are in, and adjusts every line width to fit and use recommended
 // terminal sizes for better readability. Does proper word wrapping automatically.
-//    if terminal width >= 120 columns		use 120 columns
-//    if terminal width >= 100 columns		use 100 columns
-//    if terminal width >=  80 columns		use  80 columns
+//
+//	if terminal width >= 120 columns		use 120 columns
+//	if terminal width >= 100 columns		use 100 columns
+//	if terminal width >=  80 columns		use  80 columns
+//
 // In case we're not in a terminal or if it's smaller than 80 columns width,
 // doesn't do any wrapping.
 func NewResponsiveWriter(w io.Writer) io.Writer {

tools/imctl/internal/imctl/util/term/term_writer_test.go

@@ -1,7 +1,3 @@
-// Copyright 2020 Lingfei Kong <colin404@foxmail.com>. All rights reserved.
-// Use of this source code is governed by a MIT style
-// license that can be found in the LICENSE file.
-
 package term
 
 import (

tools/ncpu/README.md

@@ -0,0 +1,47 @@
+# ncpu
+
+**ncpu** is a simple utility to fetch the number of CPU cores across different operating systems.
+
+## Introduction
+
+In various scenarios, especially while compiling code, it's beneficial to know the number of available CPU cores to optimize the build process. However, the command to fetch the CPU core count differs between operating systems. For example, on Linux, we use `nproc`, while on macOS, it's `sysctl -n hw.ncpu`. The `ncpu` utility provides a unified way to obtain this number, regardless of the platform.
+
+## Usage
+
+To retrieve the number of CPU cores, simply use the `ncpu` command:
+
+```bash
+$ ncpu
+```
+
+This will return an integer representing the number of available CPU cores.
+
+### Example:
+
+Let's say you're compiling a project using `make`. To utilize all the CPU cores for the compilation process, you can use:
+
+```bash
+$ make -j $(ncpu) build # or any other build command
+```
+
+The above command will ensure the build process takes advantage of all the available CPU cores, thereby potentially speeding up the compilation.
+
+## Why use `ncpu`?
+
+- **Cross-platform compatibility**: No need to remember or detect which OS-specific command to use. Just use `ncpu`!
+  
+- **Ease of use**: A simple and intuitive command that's easy to incorporate into scripts or command-line operations.
+
+- **Consistency**: Ensures consistent behavior and output across different systems and environments.
+
+## Installation
+
+(Include installation steps here, e.g., how to clone the repo, build the tool, or install via package manager.)
+
+## Contributing
+
+If you have any suggestions, bug reports, or wish to contribute to the development of `ncpu`, please refer to our contribution guidelines (link to guidelines).
+
+## License
+
+`ncpu` is released under the [LICENSE_NAME](LINK_TO_LICENSE). Please refer to the license file for more details.