Skip to content

Commit

Permalink
Merge pull request #269 from fluent/1.0-documentation-of-markdown-tab…
Browse files Browse the repository at this point in the history
…le-style-on-fluent-plugin-config-format

1.0: plugin-config-format: Add markdown table output style description
  • Loading branch information
cosmo0920 authored Mar 3, 2021
2 parents 3e4ee47 + 9532e41 commit cf0cd32
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion deployment/command-line-option.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Usage: fluent-plugin-config-format [options] <type> <name>
Output plugin config definitions
Arguments:
type: input,output,filter,buffer,parser,formatter,storage
type: input,output,filter,buffer,parser,formatter,storage,service_discovery
name: registered plugin name
Options:
Expand All @@ -109,6 +109,7 @@ Options:
-I PATH Add PATH to $LOAD_PATH
-r NAME Load library
-p, --plugin=DIR Add plugin directory
-t, --table Use table syntax to dump parameters
```

### Example
Expand All @@ -125,6 +126,12 @@ Generate an old-style output from the plugin's config parameters:
fluent-plugin-config-format -f txt output null
```

Generate a markdown table style output from the plugin's config parameters:

```text
fluent-plugin-config-format -f markdown --table output null
```

## `fluent-plugin-generate`

It generates the Fluentd plugin project template. It is good for starting to Fluentd plugin development for using the new API plugin. For more details, refer to the [Generating plugin project skeleton section](../plugin-development/#generating-plugin-project-skeleton).
Expand Down

0 comments on commit cf0cd32

Please sign in to comment.