xbps icon indicating copy to clipboard operation
xbps copied to clipboard

Add EXAMPLE sections to man pages

Open ericonr opened this issue 5 years ago • 4 comments
trafficstars

This is something that might have been solved by the Rosetta stone docs page too, but I think we can fix it by having EXAMPLEs in all the man pages, for common use cases. Flag composition might not be obvious to users coming from other distros.

ericonr avatar Jul 03 '20 19:07 ericonr

i'm happy to work on this.

  • [ ] xbps-alternatives
  • [ ] xbps-checkvers #316
  • [ ] xbps-create #314
  • [ ] xbps-dgraph
  • [ ] xbps-digest Unneeded?
  • [ ] xbps-fbulk
  • [ ] xbps-fetch Unneeded?
  • [ ] xbps-install #315
  • [ ] xbps-pkgdb #311
  • [ ] xbps-query #310
  • [ ] xbps-reconfigure
  • [ ] xbps-remove
  • [ ] xbps-rindex
  • [ ] xbps-uchroot
  • [ ] xbps-uhelper Covered in #305
  • [ ] xbps-uunshare
  • [ ] xbps.d

flexibeast avatar Jul 23 '20 01:07 flexibeast

I would love to see some nontrivial examples, like

  • list installed self-build packages (I use xbps-query --regex -p repository -s / | grep -v -e ' https://' -e ': /hostdir' | cut -d: -f1
  • create package depending on packages needed to build ksysguard on host
p=ksysguard
. $(xdistdir)/srcpkgs/${p}/template
xbps-create -n ${p}-build-deps-${version}_${revision} \
 -s "Build depends of ${p}" -A "$(xbps-uhelper arch)" \
 -D "$(echo $hostmakedepends $makedepends | sed 's/ />=0 /g')>=0" \
 $(mktemp -d)

Chocimier avatar Jul 23 '20 17:07 Chocimier

@Chocimier: xbps-query example added to #310, xbps-create example added in #314.

flexibeast avatar Jul 27 '20 01:07 flexibeast

Can I look into this ?

npranav7619 avatar Jun 19 '23 09:06 npranav7619