@@ -30,7 +30,9 @@ object:
3030 syscall
3131* :ref: `popen.new <popen-new >` to create a popen object with more specific options
3232
33- Below is a list of all ``popen `` functions and handle methods.
33+ Below are tables with summaries of ``popen `` constructors, constants, mrthods, and fields.
34+
35+ Popen module constructors:
3436
3537.. container :: table
3638
@@ -46,6 +48,31 @@ Below is a list of all ``popen`` functions and handle methods.
4648 | :ref: `popen.new() | Execute a child program in |
4749 | <popen-new>` | a new process |
4850 +--------------------------------------+---------------------------------+
51+
52+ Popen module constants:
53+
54+ .. container :: table
55+
56+ .. rst-class :: left-align-column-1
57+ .. rst-class :: left-align-column-2
58+
59+ +--------------------------------------+---------------------------------+
60+ | Name | Use |
61+ +======================================+=================================+
62+ | :ref: `Module constants | Module constants |
63+ | <popen-constants>` | |
64+ +--------------------------------------+---------------------------------+
65+
66+ Popen handle methods:
67+
68+ .. container :: table
69+
70+ .. rst-class :: left-align-column-1
71+ .. rst-class :: left-align-column-2
72+
73+ +--------------------------------------+---------------------------------+
74+ | Name | Use |
75+ +======================================+=================================+
4976 | :ref: `popen_handle:read() | Read data from a child peer |
5077 | <popen-read>` | |
5178 +--------------------------------------+---------------------------------+
@@ -73,16 +100,24 @@ Below is a list of all ``popen`` functions and handle methods.
73100 | :ref: `popen_handle:close() | Close a popen handle |
74101 | <popen-close>` | |
75102 +--------------------------------------+---------------------------------+
76- | :ref: `Module constants | Module constants |
77- | <popen-constants>` | |
103+
104+ Popen handle fields:
105+
106+ .. container :: table
107+
108+ .. rst-class :: left-align-column-1
109+ .. rst-class :: left-align-column-2
110+
78111 +--------------------------------------+---------------------------------+
112+ | Name | Use |
113+ +======================================+=================================+
79114 | :ref: `Handle fields | Handle fields |
80115 | <popen-handle_fields>` | |
81116 +--------------------------------------+---------------------------------+
82117
83- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
84- popen module constructors
85- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
118+ ===============================================================================
119+ popen module constructors
120+ ===============================================================================
86121
87122.. _popen-shell :
88123
@@ -377,9 +412,39 @@ Below is a list of all ``popen`` functions and handle methods.
377412 return table.concat(chunks):rstrip()
378413 end
379414
380- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
381- popen handle methods
382- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
415+ ===============================================================================
416+ popen module constants
417+ ===============================================================================
418+
419+ .. _popen-constants :
420+
421+ **Module constants **
422+
423+ .. code-block :: none
424+
425+ - popen.opts
426+ - INHERIT (== 'inherit')
427+ - DEVNULL (== 'devnull')
428+ - CLOSE (== 'close')
429+ - PIPE (== 'pipe')
430+
431+ - popen.signal
432+ - SIGTERM (== 9)
433+ - SIGKILL (== 15)
434+ - ...
435+
436+ - popen.state
437+ - ALIVE (== 'alive')
438+ - EXITED (== 'exited')
439+ - SIGNALED (== 'signaled')
440+
441+ - popen.stream
442+ - OPEN (== 'open')
443+ - CLOSED (== 'closed')
444+
445+ ===============================================================================
446+ popen handle methods
447+ ===============================================================================
383448
384449.. class :: popen_handle
385450
@@ -830,9 +895,9 @@ Below is a list of all ``popen`` functions and handle methods.
830895 means success for a caller. The return values are purely
831896 informational: they are for logging or some kind of reporting.
832897
833- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
834- popen handle fields
835- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
898+ ===============================================================================
899+ popen handle fields
900+ ===============================================================================
836901
837902 .. _popen-handle_fields :
838903
@@ -849,33 +914,3 @@ Below is a list of all ``popen`` functions and handle methods.
849914 popen_handle.stderr
850915
851916 See :ref: `popen_handle:info() <popen-info >` for details.
852-
853- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
854- popen module constants
855- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
856-
857- .. _popen-constants :
858-
859- **Module constants **
860-
861- .. code-block :: none
862-
863- - popen.opts
864- - INHERIT (== 'inherit')
865- - DEVNULL (== 'devnull')
866- - CLOSE (== 'close')
867- - PIPE (== 'pipe')
868-
869- - popen.signal
870- - SIGTERM (== 9)
871- - SIGKILL (== 15)
872- - ...
873-
874- - popen.state
875- - ALIVE (== 'alive')
876- - EXITED (== 'exited')
877- - SIGNALED (== 'signaled')
878-
879- - popen.stream
880- - OPEN (== 'open')
881- - CLOSED (== 'closed')
0 commit comments