Bug 252919 - net/rclone: man page
Summary: net/rclone: man page
Status: New
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: freebsd-bugs (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-01-22 18:52 UTC by Alexis Praga
Modified: 2021-05-15 03:01 UTC (History)
3 users (show)

See Also:


Attachments
Draft of man page for rclone (unfinished, for advice) (12.73 KB, text/plain)
2021-01-22 18:52 UTC, Alexis Praga
no flags Details
Main man page for rclone (55.66 KB, text/plain)
2021-02-03 18:06 UTC, Alexis Praga
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Alexis Praga 2021-01-22 18:52:58 UTC
Created attachment 221815 [details]
Draft of man page for rclone (unfinished, for advice)

Hello,

I've began to write a man page for rclone. As it is my first man page, I would like to submit a rather incomplete version for a guideline check.

Also, rclone has a large documentation, so I was thinking of splitting it this way :
- a very large main file with all the options and the commands
- a second file containing the configuration for all the remotes.
Another option would be to have one man page for each command, like git, but I'm not sure it's justified.

The draft linked here contains 
- a short description
- a short summary for each command
- some options 

Thanks in advance,
Comment 1 Mark Linimon freebsd_committer freebsd_triage 2021-01-22 19:17:59 UTC
Is this for the port net/rclone?  If so, we will need to edit the Product/Component.
Comment 2 Alexis Praga 2021-01-22 19:43:03 UTC
(In reply to Mark Linimon from comment #1)
Okay, I've put it in ports/individual ports and changed the summary.
Sorry, I thought a new man page should be assigned to the documentation...
Comment 3 Alexis Praga 2021-02-03 18:06:29 UTC
Created attachment 222133 [details]
Main man page for rclone
Comment 4 Alexis Praga 2021-02-03 18:11:02 UTC
There is actually a lot of documentation for rclone.
So I've decided to have a large main man page with all the options, commands briefly described, as well as examples.
Most of the documentation comes from rclone, but I've rewritten some parts here and there to be more concise.

I've put the main man page for review. If that's okay, i'll continue to follow the initial documentation structure so there will be 5 more man pages:
- one for each flag
- one for each command
- one for filters
- one for each backend
- one for remote controls
Comment 5 Brad Ackerman 2021-05-15 03:01:14 UTC
rclone does have man pages, but they're not included in the package. I'll take a look at changing that.