question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improve manpage infrastucture

See original GitHub issue

The man pages for various commands (such as dotnet-build) indicate they are generated from some other document using a tool:

$ head -1 ./dotnet-sdk-2.0.0-preview2-006497/src/cli/Documentation/manpages/sdk/dotnet-compile.1
.\" Automatically generated by Pandoc 1.15.1

What is the process to update these docs? Where can I find that original source?

Issue Analytics

  • State:open
  • Created 6 years ago
  • Comments:16 (14 by maintainers)

github_iconTop GitHub Comments

1reaction
ghostcommented, Mar 29, 2018

@nguerrera, @richlander, @Petermarcu, if hooking up pandoc script in CI is not possible for 2.1 (https://github.com/dotnet/docs/issues/2791#issuecomment-372707046), could we run pandoc script locally and send PR somewhere with all converted manpages for review? Maybe the auto-converted md files will require some manual changes. It would be very helpful if 2.1 ships out with new manpages. Thanks!

1reaction
omajidcommented, Jul 30, 2017

Also, it looks like what we want man pages to look like is already maintained here: https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish. Sources are https://github.com/dotnet/docs/tree/master/docs/core/tools

These documents are almost already in the format of man pages. Even the section names pretty much match up. Maybe it would be better to use those (somehow) rather than duplicating them. As we can already see, those docs are pretty well maintained while these man pages are completely out of date.

Read more comments on GitHub >

github_iconTop Results From Across the Web

> I would skip man pages are they just aren't used that ...
Man pages are useful because they have a standard format and layout, provide both short and long-form information, and are universally ...
Read more >
Everything you need to know about Linux man pages
Linux man pages help admins understand how to use commands in Linux. Learn how to access them and the information they offer.
Read more >
How do I use man pages to learn how to use commands?
I am trying to get better at using documentation to learn about Linux programs, but that "Synopsis" section is intimidating to new users....
Read more >
Introducing scdoc, a man page generator
My goal was to make a man page generator that had no more dependencies than man itself and would be a no-brainer for...
Read more >
Man page/Navigate - Gentoo Wiki
This guide shows how to navigate man pages using the man command. ... In this case it might be better to specify more...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found