X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_payload_size.3.xfm;h=3f7930f190a844a335534b93818ad603b3832d0e;hb=ef95978e031689e5bd7417ed033e1053a1036278;hp=7dbfa692575de3134bee14d3ae104812e1a7cafd;hpb=fd9cc7a5b3355146388ebdf4d558cb284c66c5f1;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_payload_size.3.xfm b/doc/src/man/rmr_payload_size.3.xfm index 7dbfa69..3f7930f 100644 --- a/doc/src/man/rmr_payload_size.3.xfm +++ b/doc/src/man/rmr_payload_size.3.xfm @@ -1,7 +1,7 @@ .if false ================================================================================== - Copyright (c) 2019 Nokia - Copyright (c) 2018-2019 AT&T Intellectual Property. + Copyright (c) 2019-2020 Nokia + Copyright (c) 2018-2020 AT&T Intellectual Property. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -17,32 +17,21 @@ ================================================================================== .fi .if false - Mnemonic rmr_payload_size_man.xfm - Abstract The manual page for the rmr_payload_size function. - Author E. Scott Daniels - Date 29 January 2019 + Mnemonic rmr_payload_size_man.xfm + Abstract The manual page for the rmr_payload_size function. + Author E. Scott Daniels + Date 29 January 2019 .fi -.** if formatting with tfm, the roff.im will cause roff output to be generated -.** if formatting with pfm, then pretty postscript will be generated .gv e LIB lib -.if pfm - .im &{lib}/generic_ps.im -.ei - .gv e OUTPUT_RST use_rst - .if .ev &use_rst 1 = - .im &{lib}/rst.im - .ei - .im &{lib}/roff.im - .fi -.fi +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_payload_size + rmr_payload_size &h2(SYNOPSIS ) &indent @@ -56,7 +45,7 @@ int rmr_payload_size( rmr_mbuf_t* msg ); &h2(DESCRIPTION) Given a message buffer, this function returns the amount of space (bytes) available for the user application to consume in the message payload. -This is different than the message length available as a field in the +This is different than the message length available as a field in the message buffer. &h2(RETURN VALUE) @@ -64,11 +53,12 @@ The number of bytes available in the payload. &h2(ERRORS) &beg_dlist(.75i : ^&bold_font ) -&di(INVAL) Parameter(s) passed to the function were not valid. +&ditem(INVAL) Parameter(s) passed to the function were not valid. &end_dlist &h2(SEE ALSO ) +.ju off rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3), @@ -83,7 +73,4 @@ rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3), rmr_ring_free(3) - - -.qu - +.ju on