community
/
rclone
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
rclone/docs/content/commands/rclone_gendocs.md

35 lines
815 B
Markdown
Raw Normal View History

Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-04 06:36:28 +10:00
---
title: "rclone gendocs"
docs: add description to commands and index page
2020-05-17 00:11:55 +10:00
description: "Output markdown docs for rclone to the directory supplied."
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-04 06:36:28 +10:00
slug: rclone_gendocs
url: /commands/rclone_gendocs/
gendocs: add autogenerated header to all docs
2020-02-10 23:31:45 +11:00
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/gendocs/ and as part of making a release run "make commanddocs"
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-04 06:36:28 +10:00
---
docs: make command docs titles be one higher
2020-05-22 20:17:37 +10:00
# rclone gendocs
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-04 06:36:28 +10:00
Output markdown docs for rclone to the directory supplied.
docs: make command docs titles be one higher
2020-05-22 20:17:37 +10:00
## Synopsis
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-04 06:36:28 +10:00
This produces markdown docs for the rclone commands to the directory
supplied. These are in a format suitable for hugo to render into the
rclone.org website.
```
Add ftp.md to docs builder and update docs
2017-06-16 05:12:26 +10:00
rclone gendocs output_directory [flags]
```
docs: make command docs titles be one higher
2020-05-22 20:17:37 +10:00
## Options
Add ftp.md to docs builder and update docs
2017-06-16 05:12:26 +10:00
```
-h, --help help for gendocs
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-04 06:36:28 +10:00
```
docs: add a new page with global flags and link to it from the command docs In f544234 we removed the global flags from each command as it was making each page very big and causing 1000s of lines of duplication in the man page. This change adds a new flags page with all the global flags on and links each command page to it. Fixes #3273
2019-06-21 01:18:02 +10:00
See the [global flags page](/flags/) for global options not listed here.
docs: make command docs titles be one higher
2020-05-22 20:17:37 +10:00
## SEE ALSO
Use cobra autogenerated docs * put the most up to date docs into the code * generate command docs using rclone gendocs * put command docs into own directory * remake them into MANUAL.md
2016-08-04 06:36:28 +10:00
Version v1.44
2018-10-15 21:03:08 +11:00
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
Version v1.40
2018-03-19 21:06:13 +11:00