Please document sfltool

Originator:bpavlov
Number:rdar://26846451 Date Originated:6/16/16
Status:Open Resolved:
Product:OS X Product Version:10.12
Classification: Reproducible:
 
Summary:
sfltool does not have any documentation outside of some options that can be used for it when you type 'sfltool' in the command line.

Steps to Reproduce:
1. Open up Terminal.app in the /Applications/Utilities folder
2. Type 'sfltool' and press Enter

Expected Results:
I would expect detailed usage information on what each option does and the syntax usage and any required or optional flags that can be used.
For example, if I type 'sfltool add-item' I receive no further information on what that option does. I would expect to see something more like this:

sfltool add-item (-n [Display Name]) LSSharedFileList.domain [path]

where the -n flag is optional and would allow for a Display Name to be used instead of the path specified at the end of the command.

and path must be written in a file URI format such as file:///Users/admin/Desktop/untitled%20folder/ (where space is encoded as %20)

Actual Results:
I receive one line that reads as follows:
sfltool restore|add-item|save-lists|test|archive|enable-modern|dump-server-state|clear|disable-modern|dump-storage|list-info [options]

Version:
macOS 10.12 DP 1

Notes:
This is a new tool introduced with OS X 10.11 and updated in macOS 10.12 DP 1. There was no documentation in OS X 10.11 either.

In order to discover that -n was a flag that some options take, I had to run the strings command on the sfltool binary. There is no man page similar to many other built-in OS command line tools. What does 'restore' do? What does 'save-lists' do? What does 'test' do? What is the difference between a list that is considered modernized list and one that is not? What are all the domains represent and what do they actually effect? These are just some of the questions that a man page and proper usage guide would hopefully answer for any Mac administrator interested in using this new tool.

Configuration:
All hardware supporting macOS 10.12 DP 1

Attachments:

Comments


Please note: Reports posted here will not necessarily be seen by Apple. All problems should be submitted at bugreport.apple.com before they are posted here. Please only post information for Radars that you have filed yourself, and please do not include Apple confidential information in your posts. Thank you!