# format_sub

- **Language:** C
- **Kind:** function
- **Source:** https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L3657
- **Page:** https://libtmux.org/en/tmux/3.2a/reference/c-function-format-c-format_sub/

```c
static char * format_sub(struct format_modifier *fm, const char *text, const char *pattern, const char *with)
```

## Parameters

- `fm` (`struct format_modifier *`)
- `text` (`const char *`)
- `pattern` (`const char *`)
- `with` (`const char *`)

## Called by

- [`format_replace`](/en/tmux/3.2a/reference/c-function-format-c-format_replace/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L4346)

## Calls

- [`regsub`](/en/tmux/3.2a/reference/c-function-regsub/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L3665)
- [`xstrdup`](/en/tmux/3.2a/reference/c-function-xstrdup/) (function) [Call site](https://github.com/tmux/tmux/blob/3b929f332aafa7f1080eacc31feb11ffbb1d1841/format.c#L3667)

## Referenced declarations

- [`format_modifier.argc`](/en/tmux/3.2a/reference/c-struct-format_modifier-argc/) (attribute)
- [`format_modifier.argv`](/en/tmux/3.2a/reference/c-struct-format_modifier-argv/) (attribute)
- [`format_modifier`](/en/tmux/3.2a/reference/c-struct-format_modifier/) (struct)
