• Pika@sh.itjust.works
    link
    fedilink
    English
    arrow-up
    6
    ·
    9 months ago

    that’s why any manual worth their salt has a “quick start” section at the beginning (I say this knowing most man pages fail at this or put it at the end which is super unhelpful)

    Just give me common uses and flags, you can have your more indepth stuff at the end

    • libewa@feddit.org
      link
      fedilink
      arrow-up
      2
      ·
      4 days ago

      man man-pages tells writers to only include examples if it is complicated to piece together, otherwise just explain what man page you need to read before, e.g. understanding open(3) before read(3).

      • Pika@sh.itjust.works
        link
        fedilink
        English
        arrow-up
        1
        ·
        4 days ago

        that’s interesting, I didn’t know that. Stupid design choices on so many pages suddenly make more sense.