curl / Mailing Lists / curl-library / Single Mail

Buy commercial curl support from WolfSSL. We help you work out your issues, debug your libcurl applications, use the API, port to new platforms, add new features and more. With a team lead by the curl founder himself.

libcurl man pages now written in "curldown"

Contemporary messages sorted: [ by date ] [ by thread ] [ by subject ] [ by author ] [ by messages with attachments ]

From: Daniel Stenberg via curl-library <curl-library_at_lists.haxx.se>
Date: Tue, 23 Jan 2024 00:37:06 +0100 (CET)

FYI;

I just merged https://github.com/curl/curl/pull/12730

This has now changed the file format for how we document libcurl functions and
options. From the former quirky nroff format, to the new almost-markdown
format I call curldown.

The format is documented here:

https://github.com/curl/curl/blob/master/docs/CURLDOWN.md

One of the upsides with the new format is that the man pages are immediately
browsable and quite readable on GitHub. Example:

https://github.com/curl/curl/blob/master/docs/libcurl/curl_easy_perform.md

I hope this format will make it easier for people to contribute even more to
the documentation.

(there is a similar take coming to the curl command line documentation as
well, but this PR is not ready just yet:
https://github.com/curl/curl/pull/12751)

-- 
  / daniel.haxx.se
  | Commercial curl support up to 24x7 is available!
  | Private help, bug fixes, support, ports, new features
  | https://curl.se/support.html
-- 
Unsubscribe: https://lists.haxx.se/mailman/listinfo/curl-library
Etiquette:   https://curl.se/mail/etiquette.html

Received on 2024-01-23

This message: [ Message body ]
Next message: Max via curl-library: "Correct way to disable cookies temporarily"
Previous message: Ray Satiro via curl-library: "Re: Crash in nw_in_read when client drives SSL sockets"

Contemporary messages sorted: [ by date ] [ by thread ] [ by subject ] [ by author ] [ by messages with attachments ]