Skip to content

Commit

Permalink
Add available targets docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xkaraman committed Dec 27, 2024
1 parent 362b17f commit e83de3f
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/tutorials/cmake/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
* [Customizing The Building Kamailio With CMake Options](custom.md)

* [Corresponding Old-Makefiles And CMake Commands](commands.md)

* [Available Targets](targets.md)
36 changes: 36 additions & 0 deletions docs/tutorials/cmake/targets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Kamailio Available Targets

This document lists all available targets for Kamailio with CMake, providing a brief description of each.

Use `make target_name` to execute the desired target in the build folder.

## Build Targets

- **all**: Builds all components (core and modules) of Kamailio.
- **install**: Installs the built components to the specified directory.
- **clean**: Cleans up the build directory by removing all generated files.
- **kamailio**: Builds the Kamailio core.
- **modules**: Builds all the enabled modules.
+ **module_name**: Compile module with name `module_name`, ie `make acc` for `acc` module.

- **kamctl**: Builds the `kamctl` utility, which is used for managing Kamailio configurations.
- **kamdbctl**: Builds the `kamdbctl` utility, which is used for managing Kamailio databases.

## Install Targets

- **install**: Installs the built components to the specified directory.
- **uninstall**: Uninstalls the previously installed components.
- **install-kamailio-utils**: Installs the Kamailio utilities (`kamctl` and `kamdbctl`) and kamailio congiguration files.
+ **install-kamailio-utils-bin**: Installs the Kamailio utilities binaries (kamctl kamdbctl).
+ **install-kamailio-utils-cfg**: Installs the Kamailio utilities configuration files (kamctlrc kamailio.cfg).
- **install_kamailio_docs**: Installs the Kamailio documentation.

## Documentation Targets

- **kamailio_docs**: Generates the documentation for Kamailio and it's modules.
+ **[module_name]_doc**: Generates the documentation for a specific module. Replace `module_name` with the actual module name.
* **[module_name]_txt**: Generates the documentation for a specific module in text format.
* **[module_name]_html**: Generates the documentation for a specific module in HTML format.
* **[module_name]_README**: Generates the documentation for a specific module in README format in the source code tree of each module.

- **man**: Creates the manual pages for Kamailio commands.

0 comments on commit e83de3f

Please sign in to comment.